Skip to content

Commit 8be9719

Browse files
ritzoramameshery-ci
ritzorama
authored and
meshery-ci
committed
[Docs] Update REST API Documentation
Signed-off-by: meshery <ci@meshery.io>
1 parent 7f0eec4 commit 8be9719

1 file changed

Lines changed: 170 additions & 93 deletions

File tree

‎data/openapi.yml‎

Lines changed: 170 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -13129,7 +13129,6 @@ paths:
1312913129
maxLength: 255
1313013130
modelFile:
1313113131
type: string
13132-
format: file
1313313132
description: >-
1313413133
Supported model file formats are: .tar, .tar.gz, and .tgz. See [Import Models
1313513134
Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui)
@@ -58808,7 +58807,17 @@ paths:
5880858807
- Design_designs
5880958808
summary: Upload design source content
5881058809
operationId: upsertPatternSourceContent
58811-
description: Uploads or replaces the source content for a design.
58810+
description: |
58811+
Replaces the raw source content blob stored alongside a design.
58812+
The server (meshery-cloud's UpsertPatternSourceContent handler)
58813+
reads the entire request body as opaque bytes via io.ReadAll and
58814+
persists them without interpretation, so the content-type is
58815+
whatever the uploader sent — `application/octet-stream` is the
58816+
canonical choice. The previous declaration reused
58817+
MesheryPatternImportRequestBody under multipart/form-data, which
58818+
the handler never parses; it remained wired up solely to share
58819+
a schema ref with /api/pattern/import. See meshery/schemas#771
58820+
for the drift analysis.
5881258821
parameters:
5881358822
- name: id
5881458823
in: path
@@ -58826,45 +58835,11 @@ paths:
5882658835
requestBody:
5882758836
required: true
5882858837
content:
58829-
multipart/form-data:
58838+
application/octet-stream:
5883058839
schema:
58831-
type: object
58832-
description: >-
58833-
Choose the method you prefer to upload your design file. Select 'File Upload' if you have the file on
58834-
your local system, or 'URL Import' if you have the file hosted online.
58835-
enum:
58836-
- file
58837-
- url
58838-
properties:
58839-
file:
58840-
type: string
58841-
format: file
58842-
description: >-
58843-
Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See
58844-
[Import Designs
58845-
Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui)
58846-
for details
58847-
fileName:
58848-
type: string
58849-
description: The name of the pattern file being imported.
58850-
maxLength: 500
58851-
name:
58852-
type: string
58853-
default: Untitled Design
58854-
description: >-
58855-
Provide a name for your design file. This name will help you identify the file more easily. You can
58856-
also change the name of your design after importing it.
58857-
minLength: 1
58858-
maxLength: 255
58859-
url:
58860-
type: string
58861-
format: uri
58862-
description: >-
58863-
Provide the URL of the file you want to import. This should be a direct URL to a single file, for
58864-
example: https://raw.github.com/your-design-file.yaml. Also, ensure that design is in a supported
58865-
format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See [Import Designs
58866-
Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui)
58867-
for details
58840+
type: string
58841+
format: binary
58842+
description: Opaque design source bytes (yaml, tarball, etc.)
5886858843
responses:
5886958844
'200':
5887058845
description: Design source content uploaded
@@ -58901,45 +58876,71 @@ paths:
5890158876
requestBody:
5890258877
required: true
5890358878
content:
58904-
multipart/form-data:
58879+
application/json:
5890558880
schema:
58906-
type: object
5890758881
description: >-
58908-
Choose the method you prefer to upload your design file. Select 'File Upload' if you have the file on
58909-
your local system, or 'URL Import' if you have the file hosted online.
58910-
enum:
58911-
- file
58912-
- url
58913-
properties:
58914-
file:
58915-
type: string
58916-
format: file
58917-
description: >-
58918-
Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See
58919-
[Import Designs
58920-
Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui)
58921-
for details
58922-
fileName:
58923-
type: string
58924-
description: The name of the pattern file being imported.
58925-
maxLength: 500
58926-
name:
58927-
type: string
58928-
default: Untitled Design
58882+
Body for POST /api/pattern/import. Consumed by the server as application/json. Exactly one of two
58883+
variants must be supplied: a File Import carrying base64-encoded bytes plus a file name, or a URL Import
58884+
naming a remote location the server will fetch. Sending both variants at once, or neither, is rejected
58885+
with 400.
58886+
oneOf:
58887+
- type: object
58888+
title: File Import
5892958889
description: >-
58930-
Provide a name for your design file. This name will help you identify the file more easily. You can
58931-
also change the name of your design after importing it.
58932-
minLength: 1
58933-
maxLength: 255
58934-
url:
58935-
type: string
58936-
format: uri
58890+
Upload a design file from the local system. Both `file` and `file_name` are required; the server
58891+
uses the file name to identify the file type (Kubernetes Manifest, Helm Chart, Docker Compose, or
58892+
Meshery Design).
58893+
required:
58894+
- file
58895+
- file_name
58896+
properties:
58897+
file:
58898+
type: string
58899+
format: byte
58900+
description: >-
58901+
Base64-encoded file bytes. Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose,
58902+
and Meshery Designs. See [Import Designs
58903+
Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui)
58904+
for details.
58905+
file_name:
58906+
type: string
58907+
description: >-
58908+
The name of the pattern file being imported. Include the extension (e.g. `design.yaml`), as the
58909+
server uses it to identify the file type.
58910+
maxLength: 500
58911+
name:
58912+
type: string
58913+
default: Untitled Design
58914+
description: >-
58915+
Provide a name for your design. This name will help you identify the design later. You can also
58916+
change the name of your design after importing it.
58917+
minLength: 1
58918+
maxLength: 255
58919+
- type: object
58920+
title: URL Import
5893758921
description: >-
58938-
Provide the URL of the file you want to import. This should be a direct URL to a single file, for
58939-
example: https://raw.github.com/your-design-file.yaml. Also, ensure that design is in a supported
58940-
format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See [Import Designs
58941-
Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui)
58942-
for details
58922+
Import a design by URL. The server will fetch the resource and derive the file type from the
58923+
response.
58924+
required:
58925+
- url
58926+
properties:
58927+
url:
58928+
type: string
58929+
format: uri
58930+
description: >-
58931+
A direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Ensure
58932+
the resource is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or
58933+
Meshery Design. See [Import Designs
58934+
Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui)
58935+
for details.
58936+
name:
58937+
type: string
58938+
default: Untitled Design
58939+
description: >-
58940+
Provide a name for your design. This name will help you identify the design later. You can also
58941+
change the name of your design after importing it.
58942+
minLength: 1
58943+
maxLength: 255
5894358944
responses:
5894458945
'200':
5894558946
description: Successful Import
@@ -86153,7 +86154,6 @@ components:
8615386154
maxLength: 255
8615486155
modelFile:
8615586156
type: string
86156-
format: file
8615786157
description: >-
8615886158
Supported model file formats are: .tar, .tar.gz, and .tgz. See [Import Models
8615986159
Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui)
@@ -86254,7 +86254,6 @@ components:
8625486254
maxLength: 255
8625586255
modelFile:
8625686256
type: string
86257-
format: file
8625886257
description: >-
8625986258
Supported model file formats are: .tar, .tar.gz, and .tgz. See [Import Models
8626086259
Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui)
@@ -124124,43 +124123,121 @@ components:
124124124123
minLength: 1
124125124124
maxLength: 255
124126124125
Design_MesheryPatternImportRequestBody:
124126+
description: >-
124127+
Body for POST /api/pattern/import. Consumed by the server as application/json. Exactly one of two variants must
124128+
be supplied: a File Import carrying base64-encoded bytes plus a file name, or a URL Import naming a remote
124129+
location the server will fetch. Sending both variants at once, or neither, is rejected with 400.
124130+
oneOf:
124131+
- type: object
124132+
title: File Import
124133+
description: >-
124134+
Upload a design file from the local system. Both `file` and `file_name` are required; the server uses the
124135+
file name to identify the file type (Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design).
124136+
required:
124137+
- file
124138+
- file_name
124139+
properties:
124140+
file:
124141+
type: string
124142+
format: byte
124143+
description: >-
124144+
Base64-encoded file bytes. Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and
124145+
Meshery Designs. See [Import Designs
124146+
Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui)
124147+
for details.
124148+
file_name:
124149+
type: string
124150+
description: >-
124151+
The name of the pattern file being imported. Include the extension (e.g. `design.yaml`), as the server
124152+
uses it to identify the file type.
124153+
maxLength: 500
124154+
name:
124155+
type: string
124156+
default: Untitled Design
124157+
description: >-
124158+
Provide a name for your design. This name will help you identify the design later. You can also change
124159+
the name of your design after importing it.
124160+
minLength: 1
124161+
maxLength: 255
124162+
- type: object
124163+
title: URL Import
124164+
description: Import a design by URL. The server will fetch the resource and derive the file type from the response.
124165+
required:
124166+
- url
124167+
properties:
124168+
url:
124169+
type: string
124170+
format: uri
124171+
description: >-
124172+
A direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Ensure the
124173+
resource is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design.
124174+
See [Import Designs
124175+
Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui)
124176+
for details.
124177+
name:
124178+
type: string
124179+
default: Untitled Design
124180+
description: >-
124181+
Provide a name for your design. This name will help you identify the design later. You can also change
124182+
the name of your design after importing it.
124183+
minLength: 1
124184+
maxLength: 255
124185+
Design_MesheryPatternImportFilePayload:
124127124186
type: object
124187+
title: File Import
124128124188
description: >-
124129-
Choose the method you prefer to upload your design file. Select 'File Upload' if you have the file on your
124130-
local system, or 'URL Import' if you have the file hosted online.
124131-
enum:
124189+
Upload a design file from the local system. Both `file` and `file_name` are required; the server uses the file
124190+
name to identify the file type (Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design).
124191+
required:
124132124192
- file
124133-
- url
124193+
- file_name
124134124194
properties:
124135124195
file:
124136124196
type: string
124137-
format: file
124197+
format: byte
124138124198
description: >-
124139-
Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See [Import
124140-
Designs
124199+
Base64-encoded file bytes. Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery
124200+
Designs. See [Import Designs
124141124201
Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui)
124142-
for details
124143-
fileName:
124202+
for details.
124203+
file_name:
124144124204
type: string
124145-
description: The name of the pattern file being imported.
124205+
description: >-
124206+
The name of the pattern file being imported. Include the extension (e.g. `design.yaml`), as the server uses
124207+
it to identify the file type.
124146124208
maxLength: 500
124147124209
name:
124148124210
type: string
124149124211
default: Untitled Design
124150124212
description: >-
124151-
Provide a name for your design file. This name will help you identify the file more easily. You can also
124152-
change the name of your design after importing it.
124213+
Provide a name for your design. This name will help you identify the design later. You can also change the
124214+
name of your design after importing it.
124153124215
minLength: 1
124154124216
maxLength: 255
124217+
Design_MesheryPatternImportURLPayload:
124218+
type: object
124219+
title: URL Import
124220+
description: Import a design by URL. The server will fetch the resource and derive the file type from the response.
124221+
required:
124222+
- url
124223+
properties:
124155124224
url:
124156124225
type: string
124157124226
format: uri
124158124227
description: >-
124159-
Provide the URL of the file you want to import. This should be a direct URL to a single file, for example:
124160-
https://raw.github.com/your-design-file.yaml. Also, ensure that design is in a supported format: Kubernetes
124161-
Manifest, Helm Chart, Docker Compose, or Meshery Design. See [Import Designs
124228+
A direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Ensure the
124229+
resource is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See
124230+
[Import Designs
124162124231
Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui)
124163-
for details
124232+
for details.
124233+
name:
124234+
type: string
124235+
default: Untitled Design
124236+
description: >-
124237+
Provide a name for your design. This name will help you identify the design later. You can also change the
124238+
name of your design after importing it.
124239+
minLength: 1
124240+
maxLength: 255
124164124241
Design_DesignPreferences:
124165124242
type: object
124166124243
description: Design-level preferences

0 commit comments

Comments
 (0)