cwielenb/CNCF-Dataset huggingface dataset:
Project: KICS (Provisioning / Security & Compliance)
File: e9db5fb4-6a84-4abb-b4af-3b94fbdace6d.md

title: Responses JSON Reference Does Not Exists (v2) hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: e9db5fb4-6a84-4abb-b4af-3b94fbdace6d Query name: Responses JSON Reference Does Not Exists (v2) Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Structure and Semantics URL: Responses reference should exist on responses definition field<br> ```json title="Positive test num. 1 - json file" hl_lines="14" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "$ref": "#/responses/Succes" } } } } }, "responses": { "Success": { "description": "An array with users", "schema": { "$ref": "#/definitions/User" } } }, "definitions": { "User": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="12" swagger: '2.0' info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: '200': "$ref": "#/responses/Succes" responses: Success: description: An array with users schema: "$ref": "#/definitions/User" definitions: User: type: object required: id name properties: id: type: integer format: int64 name: type: string ``` ```json title="Negative test num. 1 - json file" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "$ref": "#/responses/Success" } } } } }, "responses": { "Success": { "description": "An array with users", "schema": { "$ref": "#/definitions/User" } } }, "definitions": { "User": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } ``` ```yaml title="Negative test num. 2 - yaml file" swagger: '2.0' info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: '200': "$ref": "#/responses/Success" responses: Success: description: An array with users schema: "$ref": "#/definitions/User" definitions: User: type: object required: id name properties: id: type: integer format: int64 name: type: string ```
Project: Backstage (App Definition and Development / Application Definition & Image Build)
File: v1.21.0-next.1-changelog.md

c219b168aa: Made package public so it can be published Bumped create-app version. Updated dependencies @backstage/plugin-catalog@1.16.0-next.1 Updated dependencies @backstage/plugin-catalog@1.16.0-next.1 Updated dependencies @backstage/core-compat-api@0.0.1-next.0 Updated dependencies @backstage/core-compat-api@0.0.1-next.0 Updated dependencies @backstage/core-compat-api@0.0.1-next.0 Updated dependencies @backstage/core-compat-api@0.0.1-next.0 Updated dependencies @backstage/core-compat-api@0.0.1-next.0 Updated dependencies @backstage/core-compat-api@0.0.1-next.0 Updated dependencies @backstage/plugin-catalog@1.16.0-next.1 @backstage/plugin-techdocs@1.9.2-next.1 Updated dependencies @backstage/core-compat-api@0.0.1-next.0 Updated dependencies @backstage/plugin-catalog@1.16.0-next.1 @backstage/plugin-catalog-import@0.10.4-next.1 @backstage/plugin-graphiql@0.3.1-next.1 @backstage/plugin-search@1.4.4-next.1 @backstage/plugin-tech-radar@0.6.11-next.1 @backstage/plugin-techdocs@1.9.2-next.1 @backstage/plugin-user-settings@0.7.14-next.1 @backstage/plugin-api-docs@0.10.2-next.1 @backstage/plugin-catalog-graph@0.3.2-next.0 @backstage/plugin-explore@0.4.14-next.0 @backstage/plugin-org@0.6.18-next.0 @backstage/plugin-scaffolder@1.16.2-next.0 @backstage/plugin-scaffolder-react@1.6.2-next.0 @backstage/plugin-techdocs-module-addons-contrib@1.1.3-next.0 Updated dependencies @backstage/core-compat-api@0.0.1-next.0 @backstage/plugin-catalog@1.16.0-next.1 @backstage/plugin-catalog-import@0.10.4-next.1 @backstage/plugin-graphiql@0.3.1-next.1 @backstage/plugin-search@1.4.4-next.1 @backstage/plugin-tech-radar@0.6.11-next.1 @backstage/plugin-techdocs@1.9.2-next.1 @backstage/plugin-user-settings@0.7.14-next.1 @backstage/plugin-api-docs@0.10.2-next.1 @backstage/plugin-catalog-graph@0.3.2-next.0 @backstage/plugin-explore@0.4.14-next.0 @backstage/plugin-org@0.6.18-next.0 @backstage/plugin-scaffolder@1.16.2-next.0 @backstage/plugin-scaffolder-react@1.6.2-next.0 @backstage/plugin-techdocs-module-addons-contrib@1.1.3-next.0 Updated dependencies @backstage/create-app@0.5.8-next.1 Updated dependencies @backstage/plugin-catalog@1.16.0-next.1 @backstage/plugin-techdocs@1.9.2-next.1
Project: Backstage (App Definition and Development / Application Definition & Image Build)
File: frontend-integration.md

id: frontend-integration title: Frontend Integration description: How to place your Backstage frontend components behind authorization Now that we understand how to , let's consider cases where we'll need to supplement our policy with authorization checks on the frontend. In most cases, actual functionality that live within various plugins will already have been placed behind authorization by the plugin authors. The permission backend will use your permission policy to return an authorization result, and the plugin frontend will correspondingly show/hide/disable the relevant UI component. However, there are some cases where the integrator needs to supplement the policy on the frontend. One example is app level routing. If your Backstage permission policy may return a `DENY` for users requesting the `catalogEntityCreatePermission`, it may make sense, for example, to remove access to the `/catalog-import` page entirely: ```tsx title="packages/app/src/App.tsx" / highlight-add-start / import { RequirePermission } from '@backstage/plugin-permission-react'; import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common'; / highlight-add-end / const routes = ( <FlatRoutes> {/ highlight-remove-next-line /} <Route path="/catalog-import" element={<CatalogImportPage />} /> {/ highlight-add-start /} <Route path="/catalog-import" element={ <RequirePermission permission={catalogEntityCreatePermission}> <CatalogImportPage /> </RequirePermission> } /> {/ highlight-add-end /} {/ ... /} </FlatRoutes> ); ``` With this change, users who are denied the `catalogEntityCreatePermission` should now be unable to access the `/catalog-import` page.
Project: KICS (Provisioning / Security & Compliance)
File: 60fd272d-15f4-4d8f-afe4-77d9c6cc0453.md

title: Unsecured Commands hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 60fd272d-15f4-4d8f-afe4-77d9c6cc0453 Query name: Unsecured Commands Platform: CICD Severity: <span style="color:#ff7213">Medium</span> Category: Insecure Configurations URL: There are deprecated set-env and add-path commands that can be explicitly enabled by a user via setting the ACTIONSALLOWUNSECURE_COMMANDS environment variable as true. Depending on the use of the environment variable, this could enable an attacker to, at worst, modify the system path to run a different command than intended, resulting in arbitrary code execution.<br> ```yaml title="Positive test num. 1 - yaml file" hl_lines="8" name: Vulnerable workflow on: pullrequesttarget env: ACTIONSALLOWUNSECURE_COMMANDS: true ENVIRONMENT_NAME: prod jobs: deploy: runs-on: ubuntu-latest steps: run: | print("""${{ toJSON(github) }}""") shell: python name: Create new PR deployment uses: actions/github-script@v5 with: script: | return await github.rest.repos.createDeployment({ ...context.repo, ref: context.payload.pull_request.head.sha, auto_merge: false, required_contexts: [], environment: "${{ env.ENVIRONMENT_NAME }}", transient_environment: false, production_environment: false, }); github-token: ${{ secrets.GITHUB_TOKEN }} ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="11" name: Vulnerable workflow on: pullrequesttarget jobs: deploy: runs-on: ubuntu-latest env: ACTIONSALLOWUNSECURE_COMMANDS: true steps: run: | print("""${{ toJSON(github) }}""") shell: python name: Create new PR deployment uses: actions/github-script@v5 with: script: | return await github.rest.repos.createDeployment({ ...context.repo, ref: context.payload.pull_request.head.sha, auto_merge: false, required_contexts: [], environment: "${{ env.ENVIRONMENT_NAME }}", transient_environment: false, production_environment: false, }); github-token: ${{ secrets.GITHUB_TOKEN }} ``` ```yaml title="Positive test num. 3 - yaml file" hl_lines="16" name: Vulnerable workflow on: pullrequesttarget jobs: deploy: runs-on: ubuntu-latest steps: run: | print("""${{ toJSON(github) }}""") shell: python name: Create new PR deployment env: ACTIONSALLOWUNSECURE_COMMANDS: true uses: actions/github-script@v5 with: script: | return await github.rest.repos.createDeployment({ ...context.repo, ref: context.payload.pull_request.head.sha, auto_merge: false, required_contexts: [], environment: "${{ env.ENVIRONMENT_NAME }}", transient_environment: false, production_environment: false, }); github-token: ${{ secrets.GITHUB_TOKEN }} ``` ```yaml title="Negative test num. 1 - yaml file" name: test-positive on: pull_request: types: [opened, synchronize, edited, reopened] branches: master jobs: test-positive: runs-on: ubuntu-latest steps: name: PR comment uses: thollander/actions-comment-pull-request@b07c7f86be67002023e6cb13f57df3f21cdd3411 with: commenttag: titlecheck mode: recreate createifnot_exists: true ```
Project: Meshery (Provisioning / Automation & Configuration)
File: mesheryctl-pattern-view.md

layout: default title: mesheryctl-pattern-view permalink: reference/mesheryctl/pattern/view redirect_from: reference/mesheryctl/pattern/view/ type: reference display-title: "false" language: en command: pattern subcommand: view Display pattern(s) Displays the contents of a specific pattern based on name or id <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl pattern view pattern name [flags] </div> </pre> view a pattern <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl pattern view [pattern-name | ID] </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> -a, --all (optional) view all patterns available -h, --help help for view -o, --output-format string (optional) format to display in [json|yaml] (default "yaml") </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> --config string path to config file (default "/home/runner/.meshery/config.yaml") -t, --token string Path to token file default from current context -v, --verbose verbose output </div> </pre> Usage of mesheryctl pattern view Go back to , if you want to add content manually to the CLI documentation, please refer to the for guidance.
Project: KusionStack (Provisioning / Automation & Configuration)
File: kusion_deps.md

Show KCL file dependency information Show the KCL file dependency information in the current directory or the specified workdir. By default, it will list all the KCL files that are dependent on the given package path. ``` kusion deps [WORKDIR] [flags] ``` ``` kusion deps --focus path/to/focus1 --focus path/to/focus2 kusion deps --direct down --focus path/to/focus1 --focus path/to/focus2 kusion deps --direct down --focus path/to/focus1 --focus path/to/focus2 --only stack kusion deps --direct down --focus path/to/focus1 --focus path/to/focus2 --ignore path/to/ignore ``` ``` --direct string Project jsonyamltreehuman (default "up") --focus strings Paths to focus on to inspect. It cannot be empty and each path needs to be a valid relative path from the workdir -h, --help help for deps --ignore strings File paths to ignore when filtering the affected stacks/projects. Each path needs to be a valid relative path from the workdir. If not set, no paths will be ignored. --only string Direct is set to "down", "only" means only the downstream project/stack list will be output. Valid values: project, stack. Defaults to project (default "project") ``` - Kusion KusionStack
Project: ClickHouse (App Definition and Development / Database)
File: v22.3.17.13-lts.md

sidebar_position: 1 sidebar_label: 2023 Backported in : Allow to use String type instead of Binary in Arrow/Parquet/ORC formats. This PR introduces 3 new settings for it: `outputformatarrowstringasstring`, `outputformatparquetstringasstring`, `outputformatorcstringas_string`. Default value for all settings is `false`. (). Improve release scripts ().
Project: Meshery (Provisioning / Automation & Configuration)
File: athenz.md

layout: integration title: Athenz subtitle: Collaborative and visual infrastructure as code for Athenz image: /assets/img/integrations/athenz/icons/color/athenz-color.svg permalink: extensibility/integrations/athenz docURL: https://docs.meshery.io/extensibility/integrations/athenz description: integrations-category: Provisioning integrations-subcategory: Key Management registrant: Artifact Hub components: featureList: [ "Identities for all workloads in your hybrid environment.", "Authorization and identity provider solution for your Kubernetes clusters.", "Industry Standard Authorization mTLS bound access token." ] howItWorks: "Collaborative Infrastructure as Code" howItWorksDetails: "Collaboratively manage infrastructure with your coworkers synchronously sharing the same designs." language: en list: include type: extensibility category: integrations
Project: YDB (App Definition and Development / Database)
File: table-attribute-drop.md

With the `table attribute drop` command, you can drop a from your table. General format of the command: ```bash {{ ydb-cli }} [global options...] table attribute drop [options...] <table path> ``` `global options`: . `options`: . `table path`: The table path. Look up the description of the command to add a custom attribute: ```bash {{ ydb-cli }} table attribute drop --help ``` | Name | Description | | | `--attributes` | The key of the custom attribute to be dropped. You can list multiple keys separated by a comma (`,`). | Drop the custom attributes with the keys `attrkey1` and `attrkey2` from the `my-table` table: ```bash {{ ydb-cli }} table attribute drop --attributes attrkey1,attrkey2 my-table ```
Project: Dapr (App Definition and Development / Application Definition & Image Build)
File: v1.5.3.md

All Actor APIs return errors without an actor state store component being provided. This is the correct behavior for services that register actors, as they require state storage, but clients that invoke actors should operate with or without an actor state store. The code that initializes the Actor API raises an error when there is no actor state storage component available, regardless of whether or not the service registers actors. This fix changes the actor runtime initialization logic such that, when there is no actor state store available, the API will initialize correctly as long as the service does not register actors. As a result, the Actor API will be available to services acting only as clients (i.e invoking actors) with or without an actor state store component; the Actor API will continue to be unavailable in those services that register actors without providing an actor state store component.
Project: ArangoDB (App Definition and Development / Database)
File: error_code_throw_as_system_error_result.md

+++ title = "`errorcodethrowassystem_error<T, EC, void>`" description = "Policy class defining that the ADL discovered free function `outcomethrowassystemerrorwithpayload()` should be called on incorrect wide value observation. Inherits publicly from `base`. Can only be used with `basic_result`." +++ Note: This policy class specialisation can only be used with `basicresult`, not `basicoutcome`. Use {{% api "errorcodethrowassystemerror<T, EC, EP>" %}} with `basicoutcome`. Policy class defining that the ADL discovered free function `outcomethrowassystemerrorwithpayload(impl.assume_error())` should be called on incorrect wide value observation. . Incorrect wide error observation performs: ```c++ BOOSTOUTCOMETHROWEXCEPTION(badresult_access("no error")); ``` Inherits publicly from {{% api "base" %}}, and its narrow value, error and exception observer policies are inherited from there. Requires: Nothing. Namespace: `BOOSTOUTCOMEV2_NAMESPACE::policy` Header: `<boost/outcome/policy/resulterrorcodethrowassystemerror.hpp>`
Project: KICS (Provisioning / Security & Compliance)
File: 4d424558-c6d1-453c-be98-9a7f877abd9a.md

title: Serverless API Endpoint Config Not Private hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 4d424558-c6d1-453c-be98-9a7f877abd9a Query name: Serverless API Endpoint Config Not Private Platform: ServerlessFW Severity: <span style="color:#ff7213">Medium</span> Category: Networking and Firewall URL: Serverless should have endpointType set to 'PRIVATE'. This way, it's not exposed to the public internet<br> ```yml title="Positive test num. 1 - yml file" hl_lines="3" service: my-service frameworkVersion: '2' provider: name: aws functions: hello: events: http: path: user/create method: get ``` ```yml title="Positive test num. 2 - yml file" hl_lines="5" service: my-service frameworkVersion: '2' provider: name: aws endpointType: REGIONAL functions: hello: events: http: path: user/create method: get ``` ```yml title="Negative test num. 1 - yml file" service: my-service frameworkVersion: '2' provider: name: aws endpointType: PRIVATE vpcEndpointIds: vpce-123 vpce-456 functions: hello: events: http: path: user/create method: get ```
Project: MongoDB (App Definition and Development / Database)
File: ABSEIL_MANUAL.md

This document explains how to use Abseil throughout gRPC. Note that this isn't supposed to explain general usage of Abseil. gRPC intends to use the LTS versions of Abseil only because it simplifies dependency management. Abseil is being distributed via package distribution systems such as vcpkg and cocoapods. If gRPC depends on the certain version that aren't registered, gRPC in that system cannot get the right version of Abseil when being built, resulting in a build failure. Therefore, gRPC will use the LTS version only, preferably the latest one. Most of Abseil libraries are okay to use but there are some exceptions because they're not going well yet on some of our test machinaries or platforms it supports. The following is a list of targets that are NOT ready to use. `absl/synchronization:*`: Blocked by b/186685878. `absl/random`: . You can use Abseil in gRPC Core and gRPC C++. But you cannot use it in the public interface of gRPC C++ because i) it doesn't gurantee no breaking API changes like gRPC C++ does and ii) it may make users change their build system to address Abseil.
Project: Microcks (App Definition and Development / Application Definition & Image Build)
File: CONTRIBUTING.md

Want to contribute? Great! We try to make it easy, and all contributions, even the smaller ones, are more than welcome. This includes bug reports, fixes, documentation, examples... First, you may need to read our and then to read this page. This project uses GitHub issues to manage the issues. Open an issue directly in GitHub. If you believe you found a bug, and it's likely possible, please indicate a way to reproduce it, what you are seeing and what you would expect to see. Don't forget to indicate your Java, Maven and/or Docker version. You need to have (version >= 3.5) up and running as well as a valid Java Development Kit (version >= 17) install to build the project. ``` $ git clone https://github.com/microcks/microcks.git [...] $ cd microcks $ mvn clean install [...] [INFO] [INFO] Reactor Summary for Microcks 1.0.0-SNAPSHOT: [INFO] [INFO] Microcks ........................................... SUCCESS [ 0.234 s] [INFO] Microcks Model ..................................... SUCCESS [ 1.602 s] [INFO] Microcks EL ........................................ SUCCESS [ 1.907 s] [INFO] Microcks App ....................................... SUCCESS [ 28.038 s] [INFO] Microcks Async Minion .............................. SUCCESS [ 8.007 s] [INFO] [INFO] BUILD SUCCESS [INFO] [INFO] Total time: 40.036 s [INFO] Finished at: 2020-06-12T09:05:45+02:00 [INFO] ``` More information on how to build and run the webapp locally in development mode can be found in the . You can build a production-ready jar and run it with the following commands: ``` $ cd webapp $ mvn -Pprod package [...] $ java -jar target/microcks-x.y.z-SNAPSHOT-exec.jar ``` You'll then have a running instance of Microcks webapp on `http://localhost:8080/`. Package the application, build the docker image and use a modified docker-compose to start the application: ``` $ cd webapp $ mvn -Pprod package $ docker build -f src/main/docker/Dockerfile -t microcks:x.y.z-SNAPSHOT . [...] $ cd ../install/docker-compose $ docker-compose -f docker-compose.yml up -d ``` After spinning up the containers, you will now have access to Keycloak for account management, and microcks webapp to setup mocking, etc. You can login to keycloak on `http://localhost:18080/` with username and password `admin`. You can login to microcks webapp with the username `admin` and password `microcks123`. To contribute, use GitHub Pull Requests, from your own fork.
Project: BOSH (Provisioning / Automation & Configuration)
File: pull_request_template.md

Describe the change and why it's needed. Include any links to other PRs, stories, slack discussions, etc... that will help establish context. Include a comprehensive list of all tests run successfully. _Something brief that conveys the change and is written with the Operator audience in mind. See for examples._ Does this introduce changes that would require operators to take care in order to upgrade without a failure? It's helpful to tag a few other folks on your team or your team alias in case we need to follow up later.
Project: Keycloak (Provisioning / Security & Compliance)
File: GENERATE-DOCS.md

To generate the docs, we use a maven plugin that transforms the guides from FreeMarker enabled AsciiDoc to pure AsciiDoc. This includes linking the options from the Configuration to expose them to FreeMarker templates. FreeMarker macros are used heavily here to keep consistency throughout the guides, and to make the guides themselves as slim as possible. To help debugging, for now use the `DocsBuildDebugUtil.java` which has a main method that allows running this step outside of Maven. To build the guides, run: ``` cd docs mvn clean install ``` After that, you will have the following artifacts: `docs/guides/target/generated-guides`: pure asciidoc generated versions of the guides `docs/guides/target/generated-docs/<operator|server|migration|getting-started>/index.html`: all guides in a single html file generated with asciidoc maven plugins. Note: The layout primarily serves as an example for now and is not how we will eventually present the documentation.