Yaml examples (#58) · mittwald/developer-portal@204fd85

Commit

Yaml examples (#58)

* Bump @mittwald/flow-react-components

Bumps [@mittwald/flow-react-components](https://github.com/mittwald/flow) from 0.1.0-alpha.150 to 0.1.0-alpha.153.
- [Release notes](https://github.com/mittwald/flow/releases)
- [Changelog](https://github.com/mittwald/flow/blob/main/CHANGELOG.md)
- [Commits](mittwald/flow@0.1.0-alpha.150...0.1.0-alpha.153)

---
updated-dependencies:
- dependency-name: "@mittwald/flow-react-components"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump tsx from 4.11.2 to 4.15.7

Bumps [tsx](https://github.com/privatenumber/tsx) from 4.11.2 to 4.15.7.
- [Release notes](https://github.com/privatenumber/tsx/releases)
- [Changelog](https://github.com/privatenumber/tsx/blob/master/release.config.cjs)
- [Commits](privatenumber/tsx@v4.11.2...v4.15.7)

---
updated-dependencies:
- dependency-name: tsx
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump @types/lodash from 4.17.4 to 4.17.5

Bumps [@types/lodash](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/lodash) from 4.17.4 to 4.17.5.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/lodash)

---
updated-dependencies:
- dependency-name: "@types/lodash"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Revamp tag index pages

* Remove autogenerated category indexes

* Operation links should respect API version

* Display doccards in multiple columns; rely less on generated markdown

* Formatting

* Also add new reference index page

* Fix duplicate reference index document

* Bump @mittwald/flow-react-components

Bumps [@mittwald/flow-react-components](https://github.com/mittwald/flow) from 0.1.0-alpha.153 to 0.1.0-alpha.155.
- [Release notes](https://github.com/mittwald/flow/releases)
- [Changelog](https://github.com/mittwald/flow/blob/main/CHANGELOG.md)
- [Commits](mittwald/flow@0.1.0-alpha.153...0.1.0-alpha.155)

---
updated-dependencies:
- dependency-name: "@mittwald/flow-react-components"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Contextual help should come *after* the element

* Use "plain" variant for copy button

* Add option to customize API definitions with custom descriptions

* Bump @mittwald/flow-react-components

Bumps [@mittwald/flow-react-components](https://github.com/mittwald/flow) from 0.1.0-alpha.155 to 0.1.0-alpha.156.
- [Release notes](https://github.com/mittwald/flow/releases)
- [Changelog](https://github.com/mittwald/flow/blob/main/CHANGELOG.md)
- [Commits](mittwald/flow@0.1.0-alpha.155...0.1.0-alpha.156)

---
updated-dependencies:
- dependency-name: "@mittwald/flow-react-components"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Add option to override code examples

* Add option to override tag index pages

* Fix bug in OperationUsage, when no custom tabs were passed

* Document customization options

* Provide translations for menu items and index pages

* Make admonitions use InlineAlert component

* Use OperationDocCard for operation references

* Use specialized components to link to operations

* Update translations

* Bump @mittwald/flow-react-components

Bumps [@mittwald/flow-react-components](https://github.com/mittwald/flow) from 0.1.0-alpha.156 to 0.1.0-alpha.160.
- [Release notes](https://github.com/mittwald/flow/releases)
- [Changelog](https://github.com/mittwald/flow/blob/main/CHANGELOG.md)
- [Commits](mittwald/flow@0.1.0-alpha.156...0.1.0-alpha.160)

---
updated-dependencies:
- dependency-name: "@mittwald/flow-react-components"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bring intro page up-to-date

* Fix typo

* Add missing german translation for PHP SDK page

* Add OperationExample component to render example API calls

* Sort API tags & operations deterministically

* Refactor Schema + SchemaExample components

* Formatting

* Add translations for tab titles

* Add option to include raw JSON schema

* Use new SchemaWithExample component where possible

* Bump @mittwald/flow-react-components

Bumps [@mittwald/flow-react-components](https://github.com/mittwald/flow) from 0.1.0-alpha.160 to 0.1.0-alpha.163.
- [Release notes](https://github.com/mittwald/flow/releases)
- [Changelog](https://github.com/mittwald/flow/blob/main/CHANGELOG.md)
- [Commits](mittwald/flow@0.1.0-alpha.160...0.1.0-alpha.163)

---
updated-dependencies:
- dependency-name: "@mittwald/flow-react-components"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump @types/lodash from 4.17.5 to 4.17.6

Bumps [@types/lodash](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/lodash) from 4.17.5 to 4.17.6.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/lodash)

---
updated-dependencies:
- dependency-name: "@types/lodash"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump typescript from 5.5.2 to 5.5.3

Bumps [typescript](https://github.com/Microsoft/TypeScript) from 5.5.2 to 5.5.3.
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Changelog](https://github.com/microsoft/TypeScript/blob/main/azure-pipelines.release.yml)
- [Commits](microsoft/TypeScript@v5.5.2...v5.5.3)

---
updated-dependencies:
- dependency-name: typescript
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Bump tsx from 4.15.7 to 4.16.0

Bumps [tsx](https://github.com/privatenumber/tsx) from 4.15.7 to 4.16.0.
- [Release notes](https://github.com/privatenumber/tsx/releases)
- [Changelog](https://github.com/privatenumber/tsx/blob/master/release.config.cjs)
- [Commits](privatenumber/tsx@v4.15.7...v4.16.0)

---
updated-dependencies:
- dependency-name: tsx
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Fix display of array items in Schema component

This commit changes the display of array items so that the actual sub-schema of
said items is displayed.

This reduces the asthetic annoyance when an empty "Array[]" schema is displayed
(when no sub-schema is given), and also fixes a bug where the description of
array items was not rendered at all.

* Add option to use YAML encoding for schema examples

* Extract schema format into common data type

* use yaml examples for extension resources

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Martin Helmich <[email protected]>
Co-authored-by: Frederic Reisenhauer <[email protected]>

Loading branch information

5 people authored Jul 3, 2024

1 parent 5459ba6 commit 204fd85

docs/contributing/reference/contributor.mdx

-Original file line number
+Diff line change
@@ Expand Up @@
     <SchemaWithExample
       withRawJSONSchema
+      format="yaml"
       schema={{
         type: "object",
         required: ["id", "name", "customerId", "state", "email"],
@@ Expand Down @@

docs/contributing/reference/extensions.mdx

-Original file line number
+Diff line change
@@ Expand Up @@
     <SchemaWithExample
       withRawJSONSchema
+      format="yaml"
       schema={{
         type: "object",
         required: [
@@ Expand Down @@

docs/contributing/reference/oauth2.mdx

-Original file line number
+Diff line change
@@ Expand Up @@
     <SchemaWithExample
       withRawJSONSchema
+      format="yaml"
       schema={{
         type: "object",
         required: [
@@ Expand Down @@

docs/contributing/reference/webhooks.mdx

-Original file line number
+Diff line change
@@ Expand Up / @@ -46,6 +46,7 @@ Folgende Platzhalter können verwendet werden: @@
     <SchemaWithExample
       withRawJSONSchema
+      format="yaml"
       schema={{
         type: "object",
         required: [
@@ Expand Down Expand Up / @@ -159,6 +160,7 @@ Folgende Platzhalter können verwendet werden: @@
     <SchemaWithExample
       withRawJSONSchema
+      format="yaml"
       schema={{
         type: "object",
         required: [
@@ Expand Down Expand Up / @@ -267,6 +269,7 @@ Folgende Platzhalter können verwendet werden: @@
     <SchemaWithExample
       withRawJSONSchema
+      format="yaml"
       schema={{
         type: "object",
         required: ["apiVersion", "kind", "id", "secret", "request"],
@@ Expand Down Expand Up / @@ -327,6 +330,7 @@ Folgende Platzhalter können verwendet werden: @@
     <SchemaWithExample
       withRawJSONSchema
+      format="yaml"
       schema={{
         type: "object",
         required: [
@@ Expand Down @@

0 comments on commit `204fd85`

Please sign in to comment.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Commit

There are no files selected for viewing

0 comments on commit `204fd85`

Commit

There are no files selected for viewing

0 comments on commit 204fd85

0 comments on commit `204fd85`