Skip to content

Commit

Permalink
Merge pull request #486 from bci-oss/chore/provide-insomnia-collection
Browse files Browse the repository at this point in the history 
Create Insomnia Collection/ Update Postman Collection
  • Loading branch information
@tunacicek
tunacicek authored Nov 28, 2024
2 parents 097e642 + 8d9fa3d commit 4c927cf
Show file tree
Hide file tree
Showing 8 changed files with 220 additions and 790 deletions.
12 changes: 6 additions & 6 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
# Introduction
Following documentation is available:

| Documentation | Purpose |
|----------------------------------------------------------------------------|---------------------------------------------------------------------|
| [Arc42](architecture/) | Architecture documentation for the discovery finder. |
| [Guideline to use aws-cognito](guideline-aws-cognito-configuration.md) | Documentation to use aws cognito as identity provider |
| [Guideline to use edc-extension](guideline-edc-extension-configuration.md) | Documentation to build and use the edc extension for access control |
| [Development](development/) | Useful collections for development |
| Documentation | Purpose |
|----------------------------------------------------------------------------|---------------------------------------------------------------------------|
| [Arc42](architecture/) | Architecture documentation for the discovery finder. |
| [Guideline to use aws-cognito](guideline-aws-cognito-configuration.md) | Documentation to use aws cognito as identity provider |
| [Guideline to use edc-extension](guideline-edc-extension-configuration.md) | Documentation to build and use the edc extension for access control |
| [Development](development/) | Useful collections for development like postman/insomnia collections etc. |
1 change: 1 addition & 0 deletions docs/development/insomnia/aas-registry-v3-insomnia-collection.json
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/development/insomnia/access-rule-management-v3-insomnia-collection.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"_type":"export","__export_format":4,"__export_date":"2024-11-21T13:11:55.617Z","__export_source":"insomnia.desktop.app:v9.1.1","resources":[{"_id":"req_08ac4502374842e5938be39e1c738150","parentId":"fld_efa89625628f4f08ad16e370ea30cf04","modified":1715770471062,"created":1715770471062,"url":"{{baseUrl}}/api/v3/access-controls/rules","name":"get Rules","description":"","method":"GET","body":{},"preRequestScript":"","parameters":[],"headers":[],"authentication":{},"metaSortKey":-1715770469258,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_efa89625628f4f08ad16e370ea30cf04","parentId":"wrk_scratchpad","modified":1732194646936,"created":1715770471060,"name":"access-rule-management-v3","description":"","environment":{},"environmentPropertyOrder":{},"metaSortKey":-1715771834765,"_type":"request_group"},{"_id":"wrk_scratchpad","parentId":null,"modified":1715770262839,"created":1715770262839,"name":"Scratch Pad","description":"","scope":"collection","_type":"workspace"},{"_id":"req_7d9139c15b734d8395bfc6600dcb8f84","parentId":"fld_efa89625628f4f08ad16e370ea30cf04","modified":1715948665444,"created":1715770471063,"url":"{{baseUrl}}/api/v3/access-controls/rules","name":"create Rule","description":"","method":"POST","body":{"mimeType":"application/json","text":"{\n \"validFrom\": \"2020-01-02T03:04:05Z\",\n \"validTo\": \"4999-01-02T03:04:05Z\",\n \"description\": \"ACME policy within set validity period\",\n \"policyType\": \"AAS\",\n \"policy\": {\n \"accessRules\": [\n {\n \"attribute\": \"bpn\",\n \"operator\": \"eq\",\n \"value\": \"BPN_PROVIDER_1C\"\n },\n {\n \"attribute\": \"mandatorySpecificAssetIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"oem\",\n \"operator\": \"eq\",\n \"value\": \"oem-000-001\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSpecificAssetIdNames\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"oem\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSemanticIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"urn:bamm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified\"\n }\n ]\n }\n ]\n }\n}"},"preRequestScript":"","parameters":[],"headers":[{"name":"Content-Type","value":"application/json"}],"authentication":{},"metaSortKey":-1715770469257,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_fb5af50268a64ca49fc7d919efa6fe65","parentId":"fld_efa89625628f4f08ad16e370ea30cf04","modified":1732193975148,"created":1715770471064,"url":"{{baseUrl}}/api/v3/access-controls/rules/:ruleId","name":"get Rule by ruleId","description":"","method":"GET","body":{},"preRequestScript":"","parameters":[],"headers":[],"authentication":{},"metaSortKey":-1715770469256,"isPrivate":false,"pathParameters":[{"name":"ruleId","value":"1"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_cf662dd0be944fddb27857aed54dc13b","parentId":"fld_efa89625628f4f08ad16e370ea30cf04","modified":1732194014529,"created":1715770471064,"url":"{{baseUrl}}/api/v3/access-controls/rules/:ruleId","name":"update Rule by ruleId","description":"","method":"PUT","body":{"mimeType":"application/json","text":"{\n \"id\": 1,\n \"tid\": \"TENANT_ONE\",\n \"policyType\": \"AAS\",\n \"policy\": {\n \"accessRules\": [\n {\n \"attribute\": \"bpn\",\n \"operator\": \"eq\",\n \"value\": \"BPNL00000000000A\"\n },\n {\n \"attribute\": \"mandatorySpecificAssetIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"manufacturerPartId\",\n \"operator\": \"eq\",\n \"value\": \"99991\"\n },\n {\n \"attribute\": \"customerPartId\",\n \"operator\": \"eq\",\n \"value\": \"ACME001\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSpecificAssetIdNames\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"manufacturerPartId\"\n },\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"customerPartId\"\n },\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"partInstanceId\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSemanticIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"Traceabilityv1.1.0\"\n },\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"ProductCarbonFootprintv1.1.0\"\n }\n ]\n }\n ]\n },\n \"description\": \"Access rule description.\",\n \"validFrom\": \"2024-01-02T03:04:05Z\",\n \"validTo\": \"2024-06-07T08:09:10Z\"\n}"},"preRequestScript":"","parameters":[],"headers":[{"name":"Content-Type","value":"application/json"}],"authentication":{},"metaSortKey":-1715770469255,"isPrivate":false,"pathParameters":[{"name":"ruleId","value":"1"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_b025742919054097b87fe1fe795cb26e","parentId":"fld_efa89625628f4f08ad16e370ea30cf04","modified":1732194032123,"created":1715770471065,"url":"{{baseUrl}}/api/v3/access-controls/rules/:ruleId","name":"delete rule by ruleId","description":"","method":"DELETE","body":{},"preRequestScript":"","parameters":[],"headers":[],"authentication":{},"metaSortKey":-1715770469254,"isPrivate":false,"pathParameters":[{"name":"ruleId","value":"1"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"env_99d30891da4bdcebc63947a8fc17f076de878684","parentId":"wrk_scratchpad","modified":1732193021984,"created":1715770284186,"name":"Base Environment","data":{"baseUrl":"http://localhost:4243","edcBpn":"TENANT_ONE"},"dataPropertyOrder":{"&":["baseUrl","edcBpn"]},"color":null,"isPrivate":false,"metaSortKey":1715770284186,"_type":"environment"},{"_id":"jar_99d30891da4bdcebc63947a8fc17f076de878684","parentId":"wrk_scratchpad","modified":1715770284199,"created":1715770284199,"name":"Default Jar","cookies":[],"_type":"cookie_jar"}]}
27 changes: 0 additions & 27 deletions docs/development/postman/README.md
View file

This file was deleted.

Loading

0 comments on commit 4c927cf

Please sign in to comment.