Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation with new hidi options #1547

Merged
merged 2 commits into from
Feb 7, 2024
Merged

Update documentation with new hidi options #1547

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca77751
Update readme.md
MaggieKimani1 Feb 5, 2024
3c987ad
Update command option description
MaggieKimani1 Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 16 additions & 12 deletions src/Microsoft.OpenApi.Hidi/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,24 +68,28 @@ Used to convert file formats from JSON to YAML and vice versa and performs slici
This command accepts the following parameters:

• --openapi(-d) - OpenAPI description file path in the local filesystem or a valid URL hosted on a HTTPS server
• --csdl(-cs) - CSDL file path in the local filesystem or a valid URL hosted on a HTTPS server
• --csdlfilter(-csf) - a filter parameter that a user can use to select a subset of a large CSDL file. They do so by providing a comma delimited list of EntitySet and Singleton names that appear in the EntityContainer.
• --output(-o) - Output directory path for the transformed document
• --clean-ouput(-co) - an optional param that allows a user to overwrite an existing file.
• --version(-v) - OpenAPI specification version
• --csdl(--cs) - CSDL file path in the local filesystem or a valid URL hosted on a HTTPS server
• --csdlfilter(--csf) - a filter parameter that a user can use to select a subset of a large CSDL file. They do so by providing a comma delimited list of EntitySet and Singleton names that appear in the EntityContainer.
• --output(-o) - Output directory path for the transformed document.
• --output-folder(--of) - The output directory path for the generated files.
• --clean-ouput(--co) - an optional param that allows a user to overwrite an existing file.
• --version(-v) - OpenAPI specification version.
• --metadata-version(--mv) - Graph metadata version to use.
MaggieKimani1 marked this conversation as resolved.
Show resolved Hide resolved
• --format(-f) - File format
• --loglevel(-ll) - The log level to use when logging messages to the main output
• --inline(-i) - Inline $ref instances
• --resolveExternal(-ex) - Resolve external $refs
• --filterByOperationIds(-op) - Slice document based on OperationId(s) provided. Accepts a comma delimited list of operation ids.
• --terse-output(--to) - Produce terse json output
• --settings-path(--sp) - The configuration file with CSDL conversion settings.
• --loglevel(--ll) - The log level to use when logging messages to the main output
• --inline-local - Inline local $ref instances
• --inline-external(--ex) - Inline external $refs
• --filterByOperationIds(--op) - Slice document based on OperationId(s) provided. Accepts a comma delimited list of operation ids.
• --filterByTags(-t) - Slice document based on tag(s) provided. Accepts a comma delimited list of tags.
• --filterByCollection(-c) - Slices the OpenAPI document based on the Postman Collection file generated by Resource Explorer
• --filterByManifest (-m) - Slices the OpenAPI document based on the requests defined in the API Manifest file referenced by the provided URI. For API manifests with multiple API Dependenties, use a fragment identifier to select the desired one. e.g ./apimanifest.json#example
• --manifest (-m) - Slices the OpenAPI document based on the requests defined in the API Manifest file referenced by the provided URI. For API manifests with multiple API Dependenties, use a fragment identifier to select the desired one. e.g ./apimanifest.json#example

**Examples:**

1. Filtering by OperationIds
hidi transform -d files\People.yml -f yaml -o files\People.yml -v OpenApi3_0 -op users_UpdateInsights -co
hidi transform -d files\People.yml -f yaml -o files\People.yml -v OpenApi3_0 --op users_UpdateInsights --co

2. Filtering by Postman collection
hidi transform --openapi files\People.yml --format yaml --output files\People2.yml --version OpenApi3_0 --filterByCollection Graph-Collection-0017059134807617005.postman_collection.json
Expand All @@ -94,7 +98,7 @@ This command accepts the following parameters:
hidi transform --input Files/Todo.xml --output Files/Todo-subset.yml --format yaml --version OpenApi3_0 --filterByOperationIds Todos.Todo.UpdateTodo

4. CSDL Filtering by EntitySets and Singletons
hidi transform -cs dataverse.csdl --csdlFilter "appointments,opportunities" -o appointmentsAndOpportunities.yaml -ll trace
hidi transform --cs dataverse.csdl --csdlFilter "appointments,opportunities" -o appointmentsAndOpportunities.yaml --ll trace

Run transform -h to see all the available usage options.

Expand Down