google-apis-apigee_v1 0.84.0 → 0.85.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a8b60b48dc8f987c6409b743c8f2867ade0dc923ea84ccbf22fed285aa673b73
4
- data.tar.gz: 04e252d78f208f3a55743cb9523dfa1a2026d102661ba4c39d3b77f30dbe0a44
3
+ metadata.gz: ea84882d3fcb03ae69f2eaa2351353f4cd769cc3d84e01f529dc76b8fb2bc82b
4
+ data.tar.gz: ac6e02b0d5464500ad220893d43fb6990d879eac82c38b4bb2a4b765d7bf93fe
5
5
  SHA512:
6
- metadata.gz: 0ccea4d388773e9ed554d5bea149d5257d30001a2d1cf4407cc7093891914c24fa34dae5cbbe08b42cebf3e567db8a40852d2313a15a9065a0bd17b29f4df639
7
- data.tar.gz: 1a1918bf8dca8aa4bdd5a4c4c638cb0e5c933b832eb83cd5b363624a4860844914fc5f2364fc42da355a87b29ce4b795fec0b9e45d6b24803a3fb48d1614e359
6
+ metadata.gz: 8c69852d28aee28a9f677d9a39c5248785f4345a68bb2793c59deebfed364d264fd4bab381ab7aa4f1be3dd29f4f414117c21aff76de4f79110d8139f95a9f3f
7
+ data.tar.gz: 735ecaa3d2ca85fa9ad40b9c4f3fb54264d6a5a988175cf887aed66c0d2d304a7f64af94d5d51b5ee5b024e925477817373a0b0586e93047d761164d84fa1222
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-apigee_v1
2
2
 
3
+ ### v0.85.0 (2024-03-03)
4
+
5
+ * Regenerated from discovery document revision 20240222
6
+
3
7
  ### v0.84.0 (2024-02-24)
4
8
 
5
9
  * Regenerated from discovery document revision 20240220
@@ -553,6 +553,273 @@ module Google
553
553
  end
554
554
  end
555
555
 
556
+ # `ApiDoc` represents an API catalog item. Catalog items are used in two ways in
557
+ # a portal: - Users can browse and interact with a visual representation of the
558
+ # API documentation - The `api_product_name` field provides a link to a backing
559
+ # API product. Through this link, portal users can create and manage developer
560
+ # apps linked to one or more API products.
561
+ class GoogleCloudApigeeV1ApiDoc
562
+ include Google::Apis::Core::Hashable
563
+
564
+ # Optional. Boolean flag that manages user access to the catalog item. When true,
565
+ # the catalog item can be viewed anonymously; otherwise, only registered users
566
+ # may view it. Note: when the parent portal is enrolled in the [audience
567
+ # management feature](https://cloud.google.com/apigee/docs/api-platform/publish/
568
+ # portal/portal-audience#
569
+ # enrolling_in_the_beta_release_of_the_audience_management_feature), this flag
570
+ # is ignored; instead visibility must be further managed in the management UI (
571
+ # see [Manage the visibility of an API in your portal](https://cloud.google.com/
572
+ # apigee/docs/api-platform/publish/portal/publish-apis#visibility)).
573
+ # Corresponds to the JSON property `anonAllowed`
574
+ # @return [Boolean]
575
+ attr_accessor :anon_allowed
576
+ alias_method :anon_allowed?, :anon_allowed
577
+
578
+ # Required. Immutable. The `name` field of the associated [API product](/apigee/
579
+ # docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may
580
+ # have only one catalog item associated with a given API product.
581
+ # Corresponds to the JSON property `apiProductName`
582
+ # @return [String]
583
+ attr_accessor :api_product_name
584
+
585
+ # Optional. The IDs of the API categories to which this catalog item belongs.
586
+ # Corresponds to the JSON property `categoryIds`
587
+ # @return [Array<String>]
588
+ attr_accessor :category_ids
589
+
590
+ # Optional. Description of the catalog item. Max length is 10,000 characters.
591
+ # Corresponds to the JSON property `description`
592
+ # @return [String]
593
+ attr_accessor :description
594
+
595
+ # Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
596
+ # Corresponds to the JSON property `edgeAPIProductName`
597
+ # @return [String]
598
+ attr_accessor :edge_api_product_name
599
+
600
+ # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `
601
+ # updateDocumentation` methods
602
+ # Corresponds to the JSON property `graphqlEndpointUrl`
603
+ # @return [String]
604
+ attr_accessor :graphql_endpoint_url
605
+
606
+ # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `
607
+ # updateDocumentation` methods
608
+ # Corresponds to the JSON property `graphqlSchema`
609
+ # @return [String]
610
+ attr_accessor :graphql_schema
611
+
612
+ # Optional. DEPRECATED: manage documentation through the `getDocumentation` and `
613
+ # updateDocumentation` methods
614
+ # Corresponds to the JSON property `graphqlSchemaDisplayName`
615
+ # @return [String]
616
+ attr_accessor :graphql_schema_display_name
617
+
618
+ # Output only. The ID of the catalog item.
619
+ # Corresponds to the JSON property `id`
620
+ # @return [Fixnum]
621
+ attr_accessor :id
622
+
623
+ # Optional. Location of the image used for the catalog item in the catalog. For
624
+ # portal files, this can have the format `/files/`filename``. Max length is 2,
625
+ # 083 characters.
626
+ # Corresponds to the JSON property `imageUrl`
627
+ # @return [String]
628
+ attr_accessor :image_url
629
+
630
+ # Output only. Time the catalog item was last modified in milliseconds since
631
+ # epoch.
632
+ # Corresponds to the JSON property `modified`
633
+ # @return [Fixnum]
634
+ attr_accessor :modified
635
+
636
+ # Optional. Denotes whether the catalog item is published to the portal or is in
637
+ # a draft state. When the parent portal is enrolled in the [audience management
638
+ # feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/
639
+ # portal-audience#
640
+ # enrolling_in_the_beta_release_of_the_audience_management_feature), the
641
+ # visibility must be further managed in the management UI (see [Manage the
642
+ # visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-
643
+ # platform/publish/portal/publish-apis#visibility)) before it can be visible to
644
+ # any users. If not enrolled in the audience management feature, the visibility
645
+ # is further managed by the `anonAllowed` flag.
646
+ # Corresponds to the JSON property `published`
647
+ # @return [Boolean]
648
+ attr_accessor :published
649
+ alias_method :published?, :published
650
+
651
+ # Optional. Whether a callback URL is required when this catalog item's API
652
+ # product is enabled in a developer app. When true, a portal user will be
653
+ # required to input a URL when managing the app (this is typically used for the
654
+ # app's OAuth flow).
655
+ # Corresponds to the JSON property `requireCallbackUrl`
656
+ # @return [Boolean]
657
+ attr_accessor :require_callback_url
658
+ alias_method :require_callback_url?, :require_callback_url
659
+
660
+ # Output only. The ID of the parent portal.
661
+ # Corresponds to the JSON property `siteId`
662
+ # @return [String]
663
+ attr_accessor :site_id
664
+
665
+ # Optional. DEPRECATED: DO NOT USE
666
+ # Corresponds to the JSON property `specId`
667
+ # @return [String]
668
+ attr_accessor :spec_id
669
+
670
+ # Required. The user-facing name of the catalog item. `title` must be a non-
671
+ # empty string with a max length of 255 characters.
672
+ # Corresponds to the JSON property `title`
673
+ # @return [String]
674
+ attr_accessor :title
675
+
676
+ # Optional. DEPRECATED: use the `published` field instead
677
+ # Corresponds to the JSON property `visibility`
678
+ # @return [Boolean]
679
+ attr_accessor :visibility
680
+ alias_method :visibility?, :visibility
681
+
682
+ def initialize(**args)
683
+ update!(**args)
684
+ end
685
+
686
+ # Update properties of this object
687
+ def update!(**args)
688
+ @anon_allowed = args[:anon_allowed] if args.key?(:anon_allowed)
689
+ @api_product_name = args[:api_product_name] if args.key?(:api_product_name)
690
+ @category_ids = args[:category_ids] if args.key?(:category_ids)
691
+ @description = args[:description] if args.key?(:description)
692
+ @edge_api_product_name = args[:edge_api_product_name] if args.key?(:edge_api_product_name)
693
+ @graphql_endpoint_url = args[:graphql_endpoint_url] if args.key?(:graphql_endpoint_url)
694
+ @graphql_schema = args[:graphql_schema] if args.key?(:graphql_schema)
695
+ @graphql_schema_display_name = args[:graphql_schema_display_name] if args.key?(:graphql_schema_display_name)
696
+ @id = args[:id] if args.key?(:id)
697
+ @image_url = args[:image_url] if args.key?(:image_url)
698
+ @modified = args[:modified] if args.key?(:modified)
699
+ @published = args[:published] if args.key?(:published)
700
+ @require_callback_url = args[:require_callback_url] if args.key?(:require_callback_url)
701
+ @site_id = args[:site_id] if args.key?(:site_id)
702
+ @spec_id = args[:spec_id] if args.key?(:spec_id)
703
+ @title = args[:title] if args.key?(:title)
704
+ @visibility = args[:visibility] if args.key?(:visibility)
705
+ end
706
+ end
707
+
708
+ # The documentation for a catalog item.
709
+ class GoogleCloudApigeeV1ApiDocDocumentation
710
+ include Google::Apis::Core::Hashable
711
+
712
+ # GraphQL documentation for a catalog item.
713
+ # Corresponds to the JSON property `graphqlDocumentation`
714
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1GraphqlDocumentation]
715
+ attr_accessor :graphql_documentation
716
+
717
+ # OpenAPI Specification documentation for a catalog item.
718
+ # Corresponds to the JSON property `oasDocumentation`
719
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OasDocumentation]
720
+ attr_accessor :oas_documentation
721
+
722
+ def initialize(**args)
723
+ update!(**args)
724
+ end
725
+
726
+ # Update properties of this object
727
+ def update!(**args)
728
+ @graphql_documentation = args[:graphql_documentation] if args.key?(:graphql_documentation)
729
+ @oas_documentation = args[:oas_documentation] if args.key?(:oas_documentation)
730
+ end
731
+ end
732
+
733
+ # The catalog item documentation wrapped with response status, error_code, etc.
734
+ class GoogleCloudApigeeV1ApiDocDocumentationResponse
735
+ include Google::Apis::Core::Hashable
736
+
737
+ # The documentation for a catalog item.
738
+ # Corresponds to the JSON property `data`
739
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentation]
740
+ attr_accessor :data
741
+
742
+ # Output only. Unique error code for the request, if any.
743
+ # Corresponds to the JSON property `errorCode`
744
+ # @return [String]
745
+ attr_accessor :error_code
746
+
747
+ # Output only. Description of the operation.
748
+ # Corresponds to the JSON property `message`
749
+ # @return [String]
750
+ attr_accessor :message
751
+
752
+ # Output only. Unique ID of the request.
753
+ # Corresponds to the JSON property `requestId`
754
+ # @return [String]
755
+ attr_accessor :request_id
756
+
757
+ # Output only. Status of the operation.
758
+ # Corresponds to the JSON property `status`
759
+ # @return [String]
760
+ attr_accessor :status
761
+
762
+ def initialize(**args)
763
+ update!(**args)
764
+ end
765
+
766
+ # Update properties of this object
767
+ def update!(**args)
768
+ @data = args[:data] if args.key?(:data)
769
+ @error_code = args[:error_code] if args.key?(:error_code)
770
+ @message = args[:message] if args.key?(:message)
771
+ @request_id = args[:request_id] if args.key?(:request_id)
772
+ @status = args[:status] if args.key?(:status)
773
+ end
774
+ end
775
+
776
+ # The catalog item resource wrapped with response status, error_code, etc.
777
+ class GoogleCloudApigeeV1ApiDocResponse
778
+ include Google::Apis::Core::Hashable
779
+
780
+ # `ApiDoc` represents an API catalog item. Catalog items are used in two ways in
781
+ # a portal: - Users can browse and interact with a visual representation of the
782
+ # API documentation - The `api_product_name` field provides a link to a backing
783
+ # API product. Through this link, portal users can create and manage developer
784
+ # apps linked to one or more API products.
785
+ # Corresponds to the JSON property `data`
786
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc]
787
+ attr_accessor :data
788
+
789
+ # Unique error code for the request, if any.
790
+ # Corresponds to the JSON property `errorCode`
791
+ # @return [String]
792
+ attr_accessor :error_code
793
+
794
+ # Description of the operation.
795
+ # Corresponds to the JSON property `message`
796
+ # @return [String]
797
+ attr_accessor :message
798
+
799
+ # Unique ID of the request.
800
+ # Corresponds to the JSON property `requestId`
801
+ # @return [String]
802
+ attr_accessor :request_id
803
+
804
+ # Status of the operation.
805
+ # Corresponds to the JSON property `status`
806
+ # @return [String]
807
+ attr_accessor :status
808
+
809
+ def initialize(**args)
810
+ update!(**args)
811
+ end
812
+
813
+ # Update properties of this object
814
+ def update!(**args)
815
+ @data = args[:data] if args.key?(:data)
816
+ @error_code = args[:error_code] if args.key?(:error_code)
817
+ @message = args[:message] if args.key?(:message)
818
+ @request_id = args[:request_id] if args.key?(:request_id)
819
+ @status = args[:status] if args.key?(:status)
820
+ end
821
+ end
822
+
556
823
  #
557
824
  class GoogleCloudApigeeV1ApiProduct
558
825
  include Google::Apis::Core::Hashable
@@ -3602,6 +3869,33 @@ module Google
3602
3869
  end
3603
3870
  end
3604
3871
 
3872
+ # Documentation file contents for a catalog item.
3873
+ class GoogleCloudApigeeV1DocumentationFile
3874
+ include Google::Apis::Core::Hashable
3875
+
3876
+ # Required. The file contents. The max size is 4 MB.
3877
+ # Corresponds to the JSON property `contents`
3878
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
3879
+ # @return [String]
3880
+ attr_accessor :contents
3881
+
3882
+ # Required. A display name for the file, shown in the management UI. Max length
3883
+ # is 255 characters.
3884
+ # Corresponds to the JSON property `displayName`
3885
+ # @return [String]
3886
+ attr_accessor :display_name
3887
+
3888
+ def initialize(**args)
3889
+ update!(**args)
3890
+ end
3891
+
3892
+ # Update properties of this object
3893
+ def update!(**args)
3894
+ @contents = args[:contents] if args.key?(:contents)
3895
+ @display_name = args[:display_name] if args.key?(:display_name)
3896
+ end
3897
+ end
3898
+
3605
3899
  # Message to enable a disabled SecurityAction.
3606
3900
  class GoogleCloudApigeeV1EnableSecurityActionRequest
3607
3901
  include Google::Apis::Core::Hashable
@@ -4617,6 +4911,32 @@ module Google
4617
4911
  end
4618
4912
  end
4619
4913
 
4914
+ # GraphQL documentation for a catalog item.
4915
+ class GoogleCloudApigeeV1GraphqlDocumentation
4916
+ include Google::Apis::Core::Hashable
4917
+
4918
+ # Required. The GraphQL endpoint URI to be queried by API consumers. Max length
4919
+ # is 2,083 characters.
4920
+ # Corresponds to the JSON property `endpointUri`
4921
+ # @return [String]
4922
+ attr_accessor :endpoint_uri
4923
+
4924
+ # Documentation file contents for a catalog item.
4925
+ # Corresponds to the JSON property `schema`
4926
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DocumentationFile]
4927
+ attr_accessor :schema
4928
+
4929
+ def initialize(**args)
4930
+ update!(**args)
4931
+ end
4932
+
4933
+ # Update properties of this object
4934
+ def update!(**args)
4935
+ @endpoint_uri = args[:endpoint_uri] if args.key?(:endpoint_uri)
4936
+ @schema = args[:schema] if args.key?(:schema)
4937
+ end
4938
+ end
4939
+
4620
4940
  # Binds the resources in a proxy or remote service with the gRPC operation and
4621
4941
  # its associated quota enforcement.
4622
4942
  class GoogleCloudApigeeV1GrpcOperationConfig
@@ -5188,6 +5508,56 @@ module Google
5188
5508
  end
5189
5509
  end
5190
5510
 
5511
+ #
5512
+ class GoogleCloudApigeeV1ListApiDocsResponse
5513
+ include Google::Apis::Core::Hashable
5514
+
5515
+ # The catalog item resources.
5516
+ # Corresponds to the JSON property `data`
5517
+ # @return [Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc>]
5518
+ attr_accessor :data
5519
+
5520
+ # Unique error code for the request, if any.
5521
+ # Corresponds to the JSON property `errorCode`
5522
+ # @return [String]
5523
+ attr_accessor :error_code
5524
+
5525
+ # Description of the operation.
5526
+ # Corresponds to the JSON property `message`
5527
+ # @return [String]
5528
+ attr_accessor :message
5529
+
5530
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
5531
+ # field is omitted, there are no subsequent pages.
5532
+ # Corresponds to the JSON property `nextPageToken`
5533
+ # @return [String]
5534
+ attr_accessor :next_page_token
5535
+
5536
+ # Unique ID of the request.
5537
+ # Corresponds to the JSON property `requestId`
5538
+ # @return [String]
5539
+ attr_accessor :request_id
5540
+
5541
+ # Status of the operation.
5542
+ # Corresponds to the JSON property `status`
5543
+ # @return [String]
5544
+ attr_accessor :status
5545
+
5546
+ def initialize(**args)
5547
+ update!(**args)
5548
+ end
5549
+
5550
+ # Update properties of this object
5551
+ def update!(**args)
5552
+ @data = args[:data] if args.key?(:data)
5553
+ @error_code = args[:error_code] if args.key?(:error_code)
5554
+ @message = args[:message] if args.key?(:message)
5555
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
5556
+ @request_id = args[:request_id] if args.key?(:request_id)
5557
+ @status = args[:status] if args.key?(:status)
5558
+ end
5559
+ end
5560
+
5191
5561
  #
5192
5562
  class GoogleCloudApigeeV1ListApiProductsResponse
5193
5563
  include Google::Apis::Core::Hashable
@@ -6182,6 +6552,31 @@ module Google
6182
6552
  end
6183
6553
  end
6184
6554
 
6555
+ # OpenAPI Specification documentation for a catalog item.
6556
+ class GoogleCloudApigeeV1OasDocumentation
6557
+ include Google::Apis::Core::Hashable
6558
+
6559
+ # Output only. The format of the input specification file contents.
6560
+ # Corresponds to the JSON property `format`
6561
+ # @return [String]
6562
+ attr_accessor :format
6563
+
6564
+ # Documentation file contents for a catalog item.
6565
+ # Corresponds to the JSON property `spec`
6566
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DocumentationFile]
6567
+ attr_accessor :spec
6568
+
6569
+ def initialize(**args)
6570
+ update!(**args)
6571
+ end
6572
+
6573
+ # Update properties of this object
6574
+ def update!(**args)
6575
+ @format = args[:format] if args.key?(:format)
6576
+ @spec = args[:spec] if args.key?(:spec)
6577
+ end
6578
+ end
6579
+
6185
6580
  # Represents the pairing of REST resource path and the actions (verbs) allowed
6186
6581
  # on the resource path.
6187
6582
  class GoogleCloudApigeeV1Operation
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module ApigeeV1
18
18
  # Version of the google-apis-apigee_v1 gem
19
- GEM_VERSION = "0.84.0"
19
+ GEM_VERSION = "0.85.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.14.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240220"
25
+ REVISION = "20240222"
26
26
  end
27
27
  end
28
28
  end
@@ -124,6 +124,30 @@ module Google
124
124
  include Google::Apis::Core::JsonObjectSupport
125
125
  end
126
126
 
127
+ class GoogleCloudApigeeV1ApiDoc
128
+ class Representation < Google::Apis::Core::JsonRepresentation; end
129
+
130
+ include Google::Apis::Core::JsonObjectSupport
131
+ end
132
+
133
+ class GoogleCloudApigeeV1ApiDocDocumentation
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
139
+ class GoogleCloudApigeeV1ApiDocDocumentationResponse
140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
141
+
142
+ include Google::Apis::Core::JsonObjectSupport
143
+ end
144
+
145
+ class GoogleCloudApigeeV1ApiDocResponse
146
+ class Representation < Google::Apis::Core::JsonRepresentation; end
147
+
148
+ include Google::Apis::Core::JsonObjectSupport
149
+ end
150
+
127
151
  class GoogleCloudApigeeV1ApiProduct
128
152
  class Representation < Google::Apis::Core::JsonRepresentation; end
129
153
 
@@ -472,6 +496,12 @@ module Google
472
496
  include Google::Apis::Core::JsonObjectSupport
473
497
  end
474
498
 
499
+ class GoogleCloudApigeeV1DocumentationFile
500
+ class Representation < Google::Apis::Core::JsonRepresentation; end
501
+
502
+ include Google::Apis::Core::JsonObjectSupport
503
+ end
504
+
475
505
  class GoogleCloudApigeeV1EnableSecurityActionRequest
476
506
  class Representation < Google::Apis::Core::JsonRepresentation; end
477
507
 
@@ -616,6 +646,12 @@ module Google
616
646
  include Google::Apis::Core::JsonObjectSupport
617
647
  end
618
648
 
649
+ class GoogleCloudApigeeV1GraphqlDocumentation
650
+ class Representation < Google::Apis::Core::JsonRepresentation; end
651
+
652
+ include Google::Apis::Core::JsonObjectSupport
653
+ end
654
+
619
655
  class GoogleCloudApigeeV1GrpcOperationConfig
620
656
  class Representation < Google::Apis::Core::JsonRepresentation; end
621
657
 
@@ -706,6 +742,12 @@ module Google
706
742
  include Google::Apis::Core::JsonObjectSupport
707
743
  end
708
744
 
745
+ class GoogleCloudApigeeV1ListApiDocsResponse
746
+ class Representation < Google::Apis::Core::JsonRepresentation; end
747
+
748
+ include Google::Apis::Core::JsonObjectSupport
749
+ end
750
+
709
751
  class GoogleCloudApigeeV1ListApiProductsResponse
710
752
  class Representation < Google::Apis::Core::JsonRepresentation; end
711
753
 
@@ -946,6 +988,12 @@ module Google
946
988
  include Google::Apis::Core::JsonObjectSupport
947
989
  end
948
990
 
991
+ class GoogleCloudApigeeV1OasDocumentation
992
+ class Representation < Google::Apis::Core::JsonRepresentation; end
993
+
994
+ include Google::Apis::Core::JsonObjectSupport
995
+ end
996
+
949
997
  class GoogleCloudApigeeV1Operation
950
998
  class Representation < Google::Apis::Core::JsonRepresentation; end
951
999
 
@@ -1826,6 +1874,63 @@ module Google
1826
1874
  end
1827
1875
  end
1828
1876
 
1877
+ class GoogleCloudApigeeV1ApiDoc
1878
+ # @private
1879
+ class Representation < Google::Apis::Core::JsonRepresentation
1880
+ property :anon_allowed, as: 'anonAllowed'
1881
+ property :api_product_name, as: 'apiProductName'
1882
+ collection :category_ids, as: 'categoryIds'
1883
+ property :description, as: 'description'
1884
+ property :edge_api_product_name, as: 'edgeAPIProductName'
1885
+ property :graphql_endpoint_url, as: 'graphqlEndpointUrl'
1886
+ property :graphql_schema, as: 'graphqlSchema'
1887
+ property :graphql_schema_display_name, as: 'graphqlSchemaDisplayName'
1888
+ property :id, :numeric_string => true, as: 'id'
1889
+ property :image_url, as: 'imageUrl'
1890
+ property :modified, :numeric_string => true, as: 'modified'
1891
+ property :published, as: 'published'
1892
+ property :require_callback_url, as: 'requireCallbackUrl'
1893
+ property :site_id, as: 'siteId'
1894
+ property :spec_id, as: 'specId'
1895
+ property :title, as: 'title'
1896
+ property :visibility, as: 'visibility'
1897
+ end
1898
+ end
1899
+
1900
+ class GoogleCloudApigeeV1ApiDocDocumentation
1901
+ # @private
1902
+ class Representation < Google::Apis::Core::JsonRepresentation
1903
+ property :graphql_documentation, as: 'graphqlDocumentation', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1GraphqlDocumentation, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1GraphqlDocumentation::Representation
1904
+
1905
+ property :oas_documentation, as: 'oasDocumentation', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1OasDocumentation, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1OasDocumentation::Representation
1906
+
1907
+ end
1908
+ end
1909
+
1910
+ class GoogleCloudApigeeV1ApiDocDocumentationResponse
1911
+ # @private
1912
+ class Representation < Google::Apis::Core::JsonRepresentation
1913
+ property :data, as: 'data', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentation, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentation::Representation
1914
+
1915
+ property :error_code, as: 'errorCode'
1916
+ property :message, as: 'message'
1917
+ property :request_id, as: 'requestId'
1918
+ property :status, as: 'status'
1919
+ end
1920
+ end
1921
+
1922
+ class GoogleCloudApigeeV1ApiDocResponse
1923
+ # @private
1924
+ class Representation < Google::Apis::Core::JsonRepresentation
1925
+ property :data, as: 'data', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc::Representation
1926
+
1927
+ property :error_code, as: 'errorCode'
1928
+ property :message, as: 'message'
1929
+ property :request_id, as: 'requestId'
1930
+ property :status, as: 'status'
1931
+ end
1932
+ end
1933
+
1829
1934
  class GoogleCloudApigeeV1ApiProduct
1830
1935
  # @private
1831
1936
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2564,6 +2669,14 @@ module Google
2564
2669
  end
2565
2670
  end
2566
2671
 
2672
+ class GoogleCloudApigeeV1DocumentationFile
2673
+ # @private
2674
+ class Representation < Google::Apis::Core::JsonRepresentation
2675
+ property :contents, :base64 => true, as: 'contents'
2676
+ property :display_name, as: 'displayName'
2677
+ end
2678
+ end
2679
+
2567
2680
  class GoogleCloudApigeeV1EnableSecurityActionRequest
2568
2681
  # @private
2569
2682
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2828,6 +2941,15 @@ module Google
2828
2941
  end
2829
2942
  end
2830
2943
 
2944
+ class GoogleCloudApigeeV1GraphqlDocumentation
2945
+ # @private
2946
+ class Representation < Google::Apis::Core::JsonRepresentation
2947
+ property :endpoint_uri, as: 'endpointUri'
2948
+ property :schema, as: 'schema', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DocumentationFile, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DocumentationFile::Representation
2949
+
2950
+ end
2951
+ end
2952
+
2831
2953
  class GoogleCloudApigeeV1GrpcOperationConfig
2832
2954
  # @private
2833
2955
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2980,6 +3102,19 @@ module Google
2980
3102
  end
2981
3103
  end
2982
3104
 
3105
+ class GoogleCloudApigeeV1ListApiDocsResponse
3106
+ # @private
3107
+ class Representation < Google::Apis::Core::JsonRepresentation
3108
+ collection :data, as: 'data', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc::Representation
3109
+
3110
+ property :error_code, as: 'errorCode'
3111
+ property :message, as: 'message'
3112
+ property :next_page_token, as: 'nextPageToken'
3113
+ property :request_id, as: 'requestId'
3114
+ property :status, as: 'status'
3115
+ end
3116
+ end
3117
+
2983
3118
  class GoogleCloudApigeeV1ListApiProductsResponse
2984
3119
  # @private
2985
3120
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3325,6 +3460,15 @@ module Google
3325
3460
  end
3326
3461
  end
3327
3462
 
3463
+ class GoogleCloudApigeeV1OasDocumentation
3464
+ # @private
3465
+ class Representation < Google::Apis::Core::JsonRepresentation
3466
+ property :format, as: 'format'
3467
+ property :spec, as: 'spec', class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DocumentationFile, decorator: Google::Apis::ApigeeV1::GoogleCloudApigeeV1DocumentationFile::Representation
3468
+
3469
+ end
3470
+ end
3471
+
3328
3472
  class GoogleCloudApigeeV1Operation
3329
3473
  # @private
3330
3474
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -11532,6 +11532,244 @@ module Google
11532
11532
  execute_or_queue_command(command, &block)
11533
11533
  end
11534
11534
 
11535
+ # Creates a new catalog item.
11536
+ # @param [String] parent
11537
+ # Required. Name of the portal. Use the following structure in your request: `
11538
+ # organizations/`org`/sites/`site``
11539
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc] google_cloud_apigee_v1_api_doc_object
11540
+ # @param [String] fields
11541
+ # Selector specifying which fields to include in a partial response.
11542
+ # @param [String] quota_user
11543
+ # Available to use for quota purposes for server-side applications. Can be any
11544
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
11545
+ # @param [Google::Apis::RequestOptions] options
11546
+ # Request-specific options
11547
+ #
11548
+ # @yield [result, err] Result & error if block supplied
11549
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse] parsed result object
11550
+ # @yieldparam err [StandardError] error object if request failed
11551
+ #
11552
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse]
11553
+ #
11554
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
11555
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
11556
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
11557
+ def create_organization_site_apidoc(parent, google_cloud_apigee_v1_api_doc_object = nil, fields: nil, quota_user: nil, options: nil, &block)
11558
+ command = make_simple_command(:post, 'v1/{+parent}/apidocs', options)
11559
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc::Representation
11560
+ command.request_object = google_cloud_apigee_v1_api_doc_object
11561
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse::Representation
11562
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse
11563
+ command.params['parent'] = parent unless parent.nil?
11564
+ command.query['fields'] = fields unless fields.nil?
11565
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
11566
+ execute_or_queue_command(command, &block)
11567
+ end
11568
+
11569
+ # Deletes a catalog item.
11570
+ # @param [String] name
11571
+ # Required. Name of the catalog item. Use the following structure in your
11572
+ # request: `organizations/`org`/sites/`site`/apidocs/`apidoc``
11573
+ # @param [String] fields
11574
+ # Selector specifying which fields to include in a partial response.
11575
+ # @param [String] quota_user
11576
+ # Available to use for quota purposes for server-side applications. Can be any
11577
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
11578
+ # @param [Google::Apis::RequestOptions] options
11579
+ # Request-specific options
11580
+ #
11581
+ # @yield [result, err] Result & error if block supplied
11582
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteResponse] parsed result object
11583
+ # @yieldparam err [StandardError] error object if request failed
11584
+ #
11585
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteResponse]
11586
+ #
11587
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
11588
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
11589
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
11590
+ def delete_organization_site_apidoc(name, fields: nil, quota_user: nil, options: nil, &block)
11591
+ command = make_simple_command(:delete, 'v1/{+name}', options)
11592
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteResponse::Representation
11593
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteResponse
11594
+ command.params['name'] = name unless name.nil?
11595
+ command.query['fields'] = fields unless fields.nil?
11596
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
11597
+ execute_or_queue_command(command, &block)
11598
+ end
11599
+
11600
+ # Gets a catalog item.
11601
+ # @param [String] name
11602
+ # Required. Name of the catalog item. Use the following structure in your
11603
+ # request: `organizations/`org`/sites/`site`/apidocs/`apidoc``
11604
+ # @param [String] fields
11605
+ # Selector specifying which fields to include in a partial response.
11606
+ # @param [String] quota_user
11607
+ # Available to use for quota purposes for server-side applications. Can be any
11608
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
11609
+ # @param [Google::Apis::RequestOptions] options
11610
+ # Request-specific options
11611
+ #
11612
+ # @yield [result, err] Result & error if block supplied
11613
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse] parsed result object
11614
+ # @yieldparam err [StandardError] error object if request failed
11615
+ #
11616
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse]
11617
+ #
11618
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
11619
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
11620
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
11621
+ def get_organization_site_apidoc(name, fields: nil, quota_user: nil, options: nil, &block)
11622
+ command = make_simple_command(:get, 'v1/{+name}', options)
11623
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse::Representation
11624
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse
11625
+ command.params['name'] = name unless name.nil?
11626
+ command.query['fields'] = fields unless fields.nil?
11627
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
11628
+ execute_or_queue_command(command, &block)
11629
+ end
11630
+
11631
+ # Gets the documentation for the specified catalog item.
11632
+ # @param [String] name
11633
+ # Required. Resource name of the catalog item documentation. Use the following
11634
+ # structure in your request: `organizations/`org`/sites/`site`/apidocs/`apidoc`/
11635
+ # documentation`
11636
+ # @param [String] fields
11637
+ # Selector specifying which fields to include in a partial response.
11638
+ # @param [String] quota_user
11639
+ # Available to use for quota purposes for server-side applications. Can be any
11640
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
11641
+ # @param [Google::Apis::RequestOptions] options
11642
+ # Request-specific options
11643
+ #
11644
+ # @yield [result, err] Result & error if block supplied
11645
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentationResponse] parsed result object
11646
+ # @yieldparam err [StandardError] error object if request failed
11647
+ #
11648
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentationResponse]
11649
+ #
11650
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
11651
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
11652
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
11653
+ def get_organization_site_apidoc_documentation(name, fields: nil, quota_user: nil, options: nil, &block)
11654
+ command = make_simple_command(:get, 'v1/{+name}', options)
11655
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentationResponse::Representation
11656
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentationResponse
11657
+ command.params['name'] = name unless name.nil?
11658
+ command.query['fields'] = fields unless fields.nil?
11659
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
11660
+ execute_or_queue_command(command, &block)
11661
+ end
11662
+
11663
+ # Returns the catalog items associated with a portal.
11664
+ # @param [String] parent
11665
+ # Required. Name of the portal. Use the following structure in your request: `
11666
+ # organizations/`org`/sites/`site``
11667
+ # @param [Fixnum] page_size
11668
+ # Optional. The maximum number of items to return. The service may return fewer
11669
+ # than this value. If unspecified, at most 25 books will be returned. The
11670
+ # maximum value is 100; values above 100 will be coerced to 100.
11671
+ # @param [String] page_token
11672
+ # Optional. A page token, received from a previous `ListApiDocs` call. Provide
11673
+ # this to retrieve the subsequent page.
11674
+ # @param [String] fields
11675
+ # Selector specifying which fields to include in a partial response.
11676
+ # @param [String] quota_user
11677
+ # Available to use for quota purposes for server-side applications. Can be any
11678
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
11679
+ # @param [Google::Apis::RequestOptions] options
11680
+ # Request-specific options
11681
+ #
11682
+ # @yield [result, err] Result & error if block supplied
11683
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiDocsResponse] parsed result object
11684
+ # @yieldparam err [StandardError] error object if request failed
11685
+ #
11686
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiDocsResponse]
11687
+ #
11688
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
11689
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
11690
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
11691
+ def list_organization_site_apidocs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
11692
+ command = make_simple_command(:get, 'v1/{+parent}/apidocs', options)
11693
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiDocsResponse::Representation
11694
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiDocsResponse
11695
+ command.params['parent'] = parent unless parent.nil?
11696
+ command.query['pageSize'] = page_size unless page_size.nil?
11697
+ command.query['pageToken'] = page_token unless page_token.nil?
11698
+ command.query['fields'] = fields unless fields.nil?
11699
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
11700
+ execute_or_queue_command(command, &block)
11701
+ end
11702
+
11703
+ # Updates a catalog item.
11704
+ # @param [String] name
11705
+ # Required. Name of the catalog item. Use the following structure in your
11706
+ # request: `organizations/`org`/sites/`site`/apidocs/`apidoc``
11707
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc] google_cloud_apigee_v1_api_doc_object
11708
+ # @param [String] fields
11709
+ # Selector specifying which fields to include in a partial response.
11710
+ # @param [String] quota_user
11711
+ # Available to use for quota purposes for server-side applications. Can be any
11712
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
11713
+ # @param [Google::Apis::RequestOptions] options
11714
+ # Request-specific options
11715
+ #
11716
+ # @yield [result, err] Result & error if block supplied
11717
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse] parsed result object
11718
+ # @yieldparam err [StandardError] error object if request failed
11719
+ #
11720
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse]
11721
+ #
11722
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
11723
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
11724
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
11725
+ def update_organization_site_apidoc(name, google_cloud_apigee_v1_api_doc_object = nil, fields: nil, quota_user: nil, options: nil, &block)
11726
+ command = make_simple_command(:put, 'v1/{+name}', options)
11727
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc::Representation
11728
+ command.request_object = google_cloud_apigee_v1_api_doc_object
11729
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse::Representation
11730
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse
11731
+ command.params['name'] = name unless name.nil?
11732
+ command.query['fields'] = fields unless fields.nil?
11733
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
11734
+ execute_or_queue_command(command, &block)
11735
+ end
11736
+
11737
+ # Updates the documentation for the specified catalog item. Note that the
11738
+ # documentation file contents will not be populated in the return message.
11739
+ # @param [String] name
11740
+ # Required. Resource name of the catalog item documentation. Use the following
11741
+ # structure in your request: `organizations/`org`/sites/`site`/apidocs/`apidoc`/
11742
+ # documentation`
11743
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentation] google_cloud_apigee_v1_api_doc_documentation_object
11744
+ # @param [String] fields
11745
+ # Selector specifying which fields to include in a partial response.
11746
+ # @param [String] quota_user
11747
+ # Available to use for quota purposes for server-side applications. Can be any
11748
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
11749
+ # @param [Google::Apis::RequestOptions] options
11750
+ # Request-specific options
11751
+ #
11752
+ # @yield [result, err] Result & error if block supplied
11753
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentationResponse] parsed result object
11754
+ # @yieldparam err [StandardError] error object if request failed
11755
+ #
11756
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentationResponse]
11757
+ #
11758
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
11759
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
11760
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
11761
+ def update_organization_site_apidoc_documentation(name, google_cloud_apigee_v1_api_doc_documentation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
11762
+ command = make_simple_command(:patch, 'v1/{+name}', options)
11763
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentation::Representation
11764
+ command.request_object = google_cloud_apigee_v1_api_doc_documentation_object
11765
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentationResponse::Representation
11766
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocDocumentationResponse
11767
+ command.params['name'] = name unless name.nil?
11768
+ command.query['fields'] = fields unless fields.nil?
11769
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
11770
+ execute_or_queue_command(command, &block)
11771
+ end
11772
+
11535
11773
  # Provisions a new Apigee organization with a functioning runtime. This is the
11536
11774
  # standard way to create trial organizations for a free Apigee trial.
11537
11775
  # @param [String] project
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-apigee_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.84.0
4
+ version: 0.85.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-02-25 00:00:00.000000000 Z
11
+ date: 2024-03-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-apigee_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-apigee_v1/v0.84.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-apigee_v1/v0.85.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-apigee_v1
63
63
  post_install_message:
64
64
  rdoc_options: []