Skip to content

Commit 847efb3

Browse files
app-services-ciapp-services-ci
authored
fix(registryinstance/v1): update registryinstance/v1 SDK (#362)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent 59c847b commit 847efb3

13 files changed

Lines changed: 709 additions & 47 deletions

File tree

‎.openapi/registry-instance.json‎

Lines changed: 122 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1289,7 +1289,7 @@
12891289
},
12901290
"operationId": "getRoleMapping",
12911291
"summary": "Return a single role mapping",
1292-
"description": "Gets the details of a single role mapping (by principalId).\n\nThis operation can fail for the following reasons:\n\n* No role mapping for the principalId exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n"
1292+
"description": "Gets the details of a single role mapping (by `principalId`).\n\nThis operation can fail for the following reasons:\n\n* No role mapping for the `principalId` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n"
12931293
},
12941294
"put": {
12951295
"requestBody": {
@@ -1453,7 +1453,7 @@
14531453
}
14541454
},
14551455
"operationId": "referencesByContentHash",
1456-
"summary": "Returns a list with all the references for the artifact with the given hash",
1456+
"summary": "List artifact references by hash",
14571457
"description": "Returns a list containing all the artifact references using the artifact content hash.\n\nThis operation may fail for one of the following reasons:\n\n* A server error occurred (HTTP error `500`)\n"
14581458
},
14591459
"parameters": [
@@ -1489,8 +1489,8 @@
14891489
}
14901490
},
14911491
"operationId": "referencesByContentId",
1492-
"summary": "Returns a list with all the references for the artifact with the given content id.",
1493-
"description": "Returns a list containing all the artifact references using the artifact contentId.\n\nThis operation may fail for one of the following reasons:\n\n* A server error occurred (HTTP error `500`)"
1492+
"summary": "List artifact references by content ID",
1493+
"description": "Returns a list containing all the artifact references using the artifact content ID.\n\nThis operation may fail for one of the following reasons:\n\n* A server error occurred (HTTP error `500`)"
14941494
},
14951495
"parameters": [
14961496
{
@@ -1657,7 +1657,7 @@
16571657
}
16581658
},
16591659
"operationId": "getConfigProperty",
1660-
"summary": "Get the value of a configuration property",
1660+
"summary": "Get configuration property value",
16611661
"description": "Returns the value of a single configuration property.\n\nThis operation may fail for one of the following reasons:\n\n* Property not found or not configured (HTTP error `404`)\n* A server error occurred (HTTP error `500`)\n"
16621662
},
16631663
"put": {
@@ -2022,7 +2022,10 @@
20222022
"description": "The content of the artifact being created. This is often, but not always, JSON data\nrepresenting one of the supported artifact types:\n\n* Avro (`AVRO`)\n* Protobuf (`PROTOBUF`)\n* JSON Schema (`JSON`)\n* Kafka Connect (`KCONNECT`)\n* OpenAPI (`OPENAPI`)\n* AsyncAPI (`ASYNCAPI`)\n* GraphQL (`GRAPHQL`)\n* Web Services Description Language (`WSDL`)\n* XML Schema (`XSD`)\n",
20232023
"content": {
20242024
"*/*": {
2025-
"schema": {},
2025+
"schema": {
2026+
"format": "binary",
2027+
"type": "string"
2028+
},
20262029
"examples": {
20272030
"OpenAPI Example": {
20282031
"value": {
@@ -2163,6 +2166,26 @@
21632166
"$ref": "#/components/schemas/EncodedArtifactName"
21642167
},
21652168
"in": "header"
2169+
},
2170+
{
2171+
"name": "X-Registry-Content-Hash",
2172+
"description": "Specifies the (optional) hash of the artifact to be verified.",
2173+
"schema": {
2174+
"type": "string"
2175+
},
2176+
"in": "header"
2177+
},
2178+
{
2179+
"name": "X-Registry-Hash-Algorithm",
2180+
"description": "The algorithm to use when checking the content validity. (available: SHA256, MD5; default: SHA256)",
2181+
"schema": {
2182+
"enum": [
2183+
"SHA256",
2184+
"MD5"
2185+
],
2186+
"type": "string"
2187+
},
2188+
"in": "header"
21662189
}
21672190
],
21682191
"responses": {
@@ -2203,7 +2226,7 @@
22032226
}
22042227
},
22052228
"operationId": "deleteArtifactsInGroup",
2206-
"summary": "Deletes all artifacts in a group",
2229+
"summary": "Delete artifacts in group",
22072230
"description": "Deletes all of the artifacts that exist in a given group."
22082231
},
22092232
"parameters": [
@@ -2669,6 +2692,84 @@
26692692
"required": true
26702693
}
26712694
]
2695+
},
2696+
"/groups/{groupId}/artifacts/{artifactId}/owner": {
2697+
"summary": "Manage the ownership of a single artifact.",
2698+
"get": {
2699+
"tags": [
2700+
"Metadata"
2701+
],
2702+
"responses": {
2703+
"200": {
2704+
"content": {
2705+
"application/json": {
2706+
"schema": {
2707+
"$ref": "#/components/schemas/ArtifactOwner"
2708+
}
2709+
}
2710+
},
2711+
"description": "The artifact's owner."
2712+
},
2713+
"404": {
2714+
"$ref": "#/components/responses/NotFound"
2715+
},
2716+
"500": {
2717+
"$ref": "#/components/responses/ServerError"
2718+
}
2719+
},
2720+
"operationId": "getArtifactOwner",
2721+
"summary": "Get artifact owner",
2722+
"description": "Gets the owner of an artifact in the registry.\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)"
2723+
},
2724+
"put": {
2725+
"requestBody": {
2726+
"content": {
2727+
"application/json": {
2728+
"schema": {
2729+
"$ref": "#/components/schemas/ArtifactOwner"
2730+
}
2731+
}
2732+
},
2733+
"required": true
2734+
},
2735+
"tags": [
2736+
"Metadata"
2737+
],
2738+
"responses": {
2739+
"204": {
2740+
"description": "The owner was successfully changed."
2741+
},
2742+
"404": {
2743+
"$ref": "#/components/responses/NotFound"
2744+
},
2745+
"500": {
2746+
"$ref": "#/components/responses/ServerError"
2747+
}
2748+
},
2749+
"operationId": "updateArtifactOwner",
2750+
"summary": "Update artifact owner",
2751+
"description": "Changes the ownership of an artifact.\n\nThis operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* A server error occurred (HTTP error `500`)"
2752+
},
2753+
"parameters": [
2754+
{
2755+
"name": "groupId",
2756+
"description": "The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.",
2757+
"schema": {
2758+
"$ref": "#/components/schemas/GroupId"
2759+
},
2760+
"in": "path",
2761+
"required": true
2762+
},
2763+
{
2764+
"name": "artifactId",
2765+
"description": "The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.",
2766+
"schema": {
2767+
"$ref": "#/components/schemas/ArtifactId"
2768+
},
2769+
"in": "path",
2770+
"required": true
2771+
}
2772+
]
26722773
}
26732774
},
26742775
"components": {
@@ -3596,7 +3697,7 @@
35963697
"type": "object",
35973698
"properties": {
35983699
"content": {
3599-
"description": "Raw content of the artifact.",
3700+
"description": "Raw content of the artifact or a valid (and accessible) URL where the content can be found.",
36003701
"type": "string",
36013702
"example": ""
36023703
},
@@ -3732,6 +3833,19 @@
37323833
"maxArtifactDescriptionLengthChars": -1,
37333834
"maxRequestsPerSecondCount": -1
37343835
}
3836+
},
3837+
"ArtifactOwner": {
3838+
"title": "Root Type for ArtifactOwner",
3839+
"description": "Describes the ownership of an artifact.",
3840+
"type": "object",
3841+
"properties": {
3842+
"owner": {
3843+
"type": "string"
3844+
}
3845+
},
3846+
"example": {
3847+
"owner": "bwayne"
3848+
}
37353849
}
37363850
},
37373851
"responses": {

‎packages/registry-instance-sdk/README.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ Class | Method | HTTP request | Description
133133
*AdminApi* | [**createRoleMapping**](docs/AdminApi.md#createRoleMapping) | **POST** /admin/roleMappings | Create a new role mapping
134134
*AdminApi* | [**deleteRoleMapping**](docs/AdminApi.md#deleteRoleMapping) | **DELETE** /admin/roleMappings/{principalId} | Delete a role mapping
135135
*AdminApi* | [**exportData**](docs/AdminApi.md#exportData) | **GET** /admin/export | Export registry data
136-
*AdminApi* | [**getConfigProperty**](docs/AdminApi.md#getConfigProperty) | **GET** /admin/config/properties/{propertyName} | Get the value of a configuration property
136+
*AdminApi* | [**getConfigProperty**](docs/AdminApi.md#getConfigProperty) | **GET** /admin/config/properties/{propertyName} | Get configuration property value
137137
*AdminApi* | [**getLogConfiguration**](docs/AdminApi.md#getLogConfiguration) | **GET** /admin/loggers/{logger} | Get a single logger configuration
138138
*AdminApi* | [**getRoleMapping**](docs/AdminApi.md#getRoleMapping) | **GET** /admin/roleMappings/{principalId} | Return a single role mapping
139139
*AdminApi* | [**importData**](docs/AdminApi.md#importData) | **POST** /admin/import | Import registry data
@@ -154,14 +154,14 @@ Class | Method | HTTP request | Description
154154
*ArtifactRulesApi* | [**updateArtifactRuleConfig**](docs/ArtifactRulesApi.md#updateArtifactRuleConfig) | **PUT** /groups/{groupId}/artifacts/{artifactId}/rules/{rule} | Update artifact rule configuration
155155
*ArtifactsApi* | [**createArtifact**](docs/ArtifactsApi.md#createArtifact) | **POST** /groups/{groupId}/artifacts | Create artifact
156156
*ArtifactsApi* | [**deleteArtifact**](docs/ArtifactsApi.md#deleteArtifact) | **DELETE** /groups/{groupId}/artifacts/{artifactId} | Delete artifact
157-
*ArtifactsApi* | [**deleteArtifactsInGroup**](docs/ArtifactsApi.md#deleteArtifactsInGroup) | **DELETE** /groups/{groupId}/artifacts | Deletes all artifacts in a group
157+
*ArtifactsApi* | [**deleteArtifactsInGroup**](docs/ArtifactsApi.md#deleteArtifactsInGroup) | **DELETE** /groups/{groupId}/artifacts | Delete artifacts in group
158158
*ArtifactsApi* | [**getContentByGlobalId**](docs/ArtifactsApi.md#getContentByGlobalId) | **GET** /ids/globalIds/{globalId} | Get artifact by global ID
159159
*ArtifactsApi* | [**getContentByHash**](docs/ArtifactsApi.md#getContentByHash) | **GET** /ids/contentHashes/{contentHash}/ | Get artifact content by SHA-256 hash
160160
*ArtifactsApi* | [**getContentById**](docs/ArtifactsApi.md#getContentById) | **GET** /ids/contentIds/{contentId}/ | Get artifact content by ID
161161
*ArtifactsApi* | [**getLatestArtifact**](docs/ArtifactsApi.md#getLatestArtifact) | **GET** /groups/{groupId}/artifacts/{artifactId} | Get latest artifact
162162
*ArtifactsApi* | [**listArtifactsInGroup**](docs/ArtifactsApi.md#listArtifactsInGroup) | **GET** /groups/{groupId}/artifacts | List artifacts in group
163-
*ArtifactsApi* | [**referencesByContentHash**](docs/ArtifactsApi.md#referencesByContentHash) | **GET** /ids/contentHashes/{contentHash}/references | Returns a list with all the references for the artifact with the given hash
164-
*ArtifactsApi* | [**referencesByContentId**](docs/ArtifactsApi.md#referencesByContentId) | **GET** /ids/contentIds/{contentId}/references | Returns a list with all the references for the artifact with the given content id.
163+
*ArtifactsApi* | [**referencesByContentHash**](docs/ArtifactsApi.md#referencesByContentHash) | **GET** /ids/contentHashes/{contentHash}/references | List artifact references by hash
164+
*ArtifactsApi* | [**referencesByContentId**](docs/ArtifactsApi.md#referencesByContentId) | **GET** /ids/contentIds/{contentId}/references | List artifact references by content ID
165165
*ArtifactsApi* | [**referencesByGlobalId**](docs/ArtifactsApi.md#referencesByGlobalId) | **GET** /ids/globalIds/{globalId}/references | Returns a list with all the references for the artifact with the given global id.
166166
*ArtifactsApi* | [**updateArtifact**](docs/ArtifactsApi.md#updateArtifact) | **PUT** /groups/{groupId}/artifacts/{artifactId} | Update artifact
167167
*ArtifactsApi* | [**updateArtifactState**](docs/ArtifactsApi.md#updateArtifactState) | **PUT** /groups/{groupId}/artifacts/{artifactId}/state | Update artifact state
@@ -173,9 +173,11 @@ Class | Method | HTTP request | Description
173173
*GlobalRulesApi* | [**updateGlobalRuleConfig**](docs/GlobalRulesApi.md#updateGlobalRuleConfig) | **PUT** /admin/rules/{rule} | Update global rule configuration
174174
*MetadataApi* | [**deleteArtifactVersionMetaData**](docs/MetadataApi.md#deleteArtifactVersionMetaData) | **DELETE** /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta | Delete artifact version metadata
175175
*MetadataApi* | [**getArtifactMetaData**](docs/MetadataApi.md#getArtifactMetaData) | **GET** /groups/{groupId}/artifacts/{artifactId}/meta | Get artifact metadata
176+
*MetadataApi* | [**getArtifactOwner**](docs/MetadataApi.md#getArtifactOwner) | **GET** /groups/{groupId}/artifacts/{artifactId}/owner | Get artifact owner
176177
*MetadataApi* | [**getArtifactVersionMetaData**](docs/MetadataApi.md#getArtifactVersionMetaData) | **GET** /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta | Get artifact version metadata
177178
*MetadataApi* | [**getArtifactVersionMetaDataByContent**](docs/MetadataApi.md#getArtifactVersionMetaDataByContent) | **POST** /groups/{groupId}/artifacts/{artifactId}/meta | Get artifact version metadata by content
178179
*MetadataApi* | [**updateArtifactMetaData**](docs/MetadataApi.md#updateArtifactMetaData) | **PUT** /groups/{groupId}/artifacts/{artifactId}/meta | Update artifact metadata
180+
*MetadataApi* | [**updateArtifactOwner**](docs/MetadataApi.md#updateArtifactOwner) | **PUT** /groups/{groupId}/artifacts/{artifactId}/owner | Update artifact owner
179181
*MetadataApi* | [**updateArtifactVersionMetaData**](docs/MetadataApi.md#updateArtifactVersionMetaData) | **PUT** /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta | Update artifact version metadata
180182
*SearchApi* | [**searchArtifacts**](docs/SearchApi.md#searchArtifacts) | **GET** /search/artifacts | Search for artifacts
181183
*SearchApi* | [**searchArtifactsByContent**](docs/SearchApi.md#searchArtifactsByContent) | **POST** /search/artifacts | Search for artifacts by content
@@ -192,6 +194,7 @@ Class | Method | HTTP request | Description
192194
## Documentation for Models
193195

194196
- [ArtifactMetaData](docs/ArtifactMetaData.md)
197+
- [ArtifactOwner](docs/ArtifactOwner.md)
195198
- [ArtifactReference](docs/ArtifactReference.md)
196199
- [ArtifactSearchResults](docs/ArtifactSearchResults.md)
197200
- [ArtifactState](docs/ArtifactState.md)

0 commit comments

Comments
 (0)